You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by wu...@apache.org on 2021/09/06 14:20:43 UTC
[skywalking-infra-e2e] branch main updated: Polishing
documentations (#41)
This is an automated email from the ASF dual-hosted git repository.
wusheng pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/skywalking-infra-e2e.git
The following commit(s) were added to refs/heads/main by this push:
new 5fb8ba1 Polishing documentations (#41)
5fb8ba1 is described below
commit 5fb8ba17ac33c1e7b54d3d84aadd62015d53900a
Author: mrproliu <74...@qq.com>
AuthorDate: Mon Sep 6 22:20:18 2021 +0800
Polishing documentations (#41)
Co-authored-by: Mrproliu <110106ASDasd>
---
docs/README.md | 4 +++-
docs/en/{guide => contribution}/Compiling-Guidance.md | 0
docs/en/contribution/README.md | 5 +++++
docs/en/guide/README.md | 15 ---------------
docs/en/{guide => }/setup/Configuration-File.md | 4 ++--
docs/en/setup/README.md | 7 +++++++
docs/en/{guide => }/setup/Run-E2E-Tests.md | 0
docs/menu.yml | 18 ++++++++----------
8 files changed, 25 insertions(+), 28 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 36d33da..ba3ddf9 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -8,7 +8,9 @@ From here you can learn all about **SkyWalking Infra E2E's** architecture, how t
- [Concepts and Designs](en/concepts-and-designs/README.md). The most important core ideas about SkyWalking Infra E2E. You can learn from here if you want to understand what is going on under our cool features.
-- [Guide](en/guide/README.md). Introduce how to set up and running E2E testing.
+- [Setup](en/setup/README.md). Introduce how to set up and running E2E testing.
+
+- [Contribution](en/contribution/README.md). Introduce how to contribute SkyWalking Infra E2E.
We're always looking for help improve our documentation and codes, so please don’t hesitate to [file an issue](https://github.com/apache/skywalking/issues/new)
if you see any problem.
diff --git a/docs/en/guide/Compiling-Guidance.md b/docs/en/contribution/Compiling-Guidance.md
similarity index 100%
rename from docs/en/guide/Compiling-Guidance.md
rename to docs/en/contribution/Compiling-Guidance.md
diff --git a/docs/en/contribution/README.md b/docs/en/contribution/README.md
new file mode 100644
index 0000000..3627137
--- /dev/null
+++ b/docs/en/contribution/README.md
@@ -0,0 +1,5 @@
+# Contribution
+If you want to debug or develop SkyWalking Infra E2E, The following documentations would guide you.
+
+- Compiling
+ - [Compiling Guidance](./Compiling-Guidance.md)
\ No newline at end of file
diff --git a/docs/en/guide/README.md b/docs/en/guide/README.md
deleted file mode 100644
index df835b6..0000000
--- a/docs/en/guide/README.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Guide
-
-If you want to debug, develop or execute SkyWalking Infra E2E, The following documentation would guide you.
-
-## Compiling
-
-* [Compiling Guidance](Compiling-Guidance.md)
-
-## Set up
-
-The most important thing in E2E Testing is that it uses a separate configuration file and command to execute.
-If you haven't read the [Module Design](../concepts-and-designs/module-design.md), recommend read this document first.
-
-* [Configuration file](setup/Configuration-File.md)
-* [Run E2E Tests](setup/Run-E2E-Tests.md)
\ No newline at end of file
diff --git a/docs/en/guide/setup/Configuration-File.md b/docs/en/setup/Configuration-File.md
similarity index 98%
rename from docs/en/guide/setup/Configuration-File.md
rename to docs/en/setup/Configuration-File.md
index 7a724f4..9384609 100644
--- a/docs/en/guide/setup/Configuration-File.md
+++ b/docs/en/setup/Configuration-File.md
@@ -1,7 +1,7 @@
# SkyWalking Infra E2E Configuration Guide
The configuration file is used to integrate all the step configuration content.
-You can see the sample configuration files for different environments in the [examples directory](../../../../examples).
+You can see the sample configuration files for different environments in the [examples directory](../../../examples).
There is a quick view about the configuration file, and using the `yaml` format.
```yaml
@@ -127,7 +127,7 @@ Support two kind source to verify, one case only supports one kind source type:
After clarifying the content that needs to be verified, you need to write content to verify the real content and ensure that the data is correct.
You need to use the form of [Go Template](https://pkg.go.dev/text/template#pkg-overview) to write the verification file, and the data content to be rendered comes from the real data. By verifying whether the rendered data is consistent with the real data, it is verified whether the content is consistent.
-You could see [many test cases in this directory](../../../../test/verify).
+You could see [many test cases in this directory](../../../test/verify).
We have done a lot of extension functions for verification functions on the original Go Template.
diff --git a/docs/en/setup/README.md b/docs/en/setup/README.md
new file mode 100644
index 0000000..679d47b
--- /dev/null
+++ b/docs/en/setup/README.md
@@ -0,0 +1,7 @@
+# Setup
+
+The most important thing in E2E Testing is that it uses a separate configuration file and command to execute.
+If you haven't read the [Module Design](../concepts-and-designs/module-design.md), recommend read this document first.
+
+* [Configuration file](Configuration-File.md)
+* [Run E2E Tests](Run-E2E-Tests.md)
\ No newline at end of file
diff --git a/docs/en/guide/setup/Run-E2E-Tests.md b/docs/en/setup/Run-E2E-Tests.md
similarity index 100%
rename from docs/en/guide/setup/Run-E2E-Tests.md
rename to docs/en/setup/Run-E2E-Tests.md
diff --git a/docs/menu.yml b/docs/menu.yml
index 5759724..71e2dbd 100644
--- a/docs/menu.yml
+++ b/docs/menu.yml
@@ -25,15 +25,13 @@ catalog:
path: /en/concepts-and-designs/project-goals
- name: Module Design
path: /en/concepts-and-designs/module-design
- - name: Guide
+ - name: Setup
+ catalog:
+ - name: Configuration file
+ path: /en/setup/configuration-file
+ - name: Run E2E Tests
+ path: /en/setup/run-e2e-tests
+ - name: Contribution
catalog:
- - name: Guide
- path: /en/guide/readme
- name: Compiling Guidance
- path: /en/guide/compiling-guidance
- - name: Set up
- catalog:
- - name: configuration file
- path: /en/guide/execute/configuration-file
- - name: Run E2E Tests
- path: /en/guide/execute/run-e2e-tests
\ No newline at end of file
+ path: /en/contribution/compiling-guidance
\ No newline at end of file