Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganized the documents structure #405

Merged
merged 18 commits into from
Dec 10, 2021
Merged

Reorganized the documents structure #405

merged 18 commits into from
Dec 10, 2021

Conversation

haoel
Copy link
Contributor

@haoel haoel commented Dec 9, 2021

  1. Move the reference document into ./doc/reference directory.
  2. Write the ./doc/README.md to index all of the documents.
  3. remove the original filters.md and cookbook/README.md.
  4. rename the original reference.md to filters.md
  5. move all of the images into doc/imgs/ directory.
  6. rename the file name, change the _ to -

doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/reference/controllers.md Outdated Show resolved Hide resolved
haoel and others added 3 commits December 9, 2021 17:14
Co-authored-by: Samu Tamminen <[email protected]>
Co-authored-by: Samu Tamminen <[email protected]>
Copy link
Contributor

@suchen-sci suchen-sci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the new structure of doc looks pretty good!

Is that a good idea to put all images into a single directory?

I find some file name connect words use "_" and some use "-" for example "api_aggregator.md" and "developer-guide.md". Is that a good idea to make all md file use same pattern?

@haoel
Copy link
Contributor Author

haoel commented Dec 9, 2021

the new structure of doc looks pretty good!

Is that a good idea to put all images into a single directory?

I find some file name connect words use "_" and some use "-" for example "api_aggregator.md" and "developer-guide.md". Is that a good idea to make all md file use same pattern?

those are good ideas, let me work them out!

doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/README.md Outdated Show resolved Hide resolved
doc/README.md Show resolved Hide resolved
@haoel haoel merged commit d04cc65 into easegress-io:main Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants