Restore Docs removed by sync-readme task #446
Conversation
The recently introduced sync-readme task removed a lot of relevant information from the README: cloudfoundry#423 This commit restores most of the content and puts it into the new structure under docs/ Previous README: https://github.com/cloudfoundry/gorouter/blob/ddb5a02d761fc62457740e67a8abeef3eca9bef0/README.md
|
@winkingturtle-vmw |
docs/01-development-guide.md
Outdated
| Please report all issues and feature requests in [cloudfoundry/routing-release](https://github.com/cloudfoundry/routing-release). | ||
|
|
||
| # Development Guide | ||
| ## Contributing |
There was a problem hiding this comment.
@a18e This information along with how to run tests or build binaries is all in the main README.me under Contributing. I would stay away from repeating this information in the development-guide file.
There was a problem hiding this comment.
Yep, you're right. Removed the Contributing section.
But the content of the Setup section is actually quite different from CONTRIBUTING.md since it's gorouter specific.
| @@ -0,0 +1,388 @@ | |||
| # Features | |||
There was a problem hiding this comment.
Even md file needs a metadata block like the other ones in order to show up in the main README.
There was a problem hiding this comment.
Thanks, added them, please re-review.
It would also be nice to have this documented somewhere (and this documentation ideally linked in the README note, rather than just referring to "a convention").
|
@a18e We can add Features and Observability MD files, but I think the changes proposed for development-guide is repeated somewhere else. |
Add front matter to new pages Remove Contribution chapter from development guide Use github admonitions Formatting Add reference to RFC-0027 (per-route-options)
|
@winkingturtle-vmw Thanks for the review already. I also have some more general questions regarding the
|
3 participants
Summary
In #423, the
sync-readmetask removed a lot of relevant information from the old README that was never moved to the new docs structure.This PR restores most of the content and puts it into the new structure under
docs/.Some caveats:
README.md(especially the TOC there). It does say that the file is autogenerated, but I can't find any more information on thesync-readmetask other than the linked metadata.yml file.vim-markdown-toc GFM) since it's not consistently used across the various docs in the org (and I believe it to be redundant to IDE or github.com TOC features). I can restore it or remove it from 02-nats-configuration.md as well, just need to know which is preferred.Backward Compatibility
Breaking Change? No