[WIP] docs: Add developers section to docs #13745
Conversation
Signed-off-by: Ryan Northey <ryan@synca.io>
|
/retest |
|
Retrying Azure Pipelines. |
|
@mattklein123 this is a really first pass attempt to thrash out a rough structure for dev docs - with one eye on what im aware of in terms of existing docs, and the other on how we might best structure this from pov of developers getting started rendered docs (no copy etc atm) are here: https://storage.googleapis.com/envoy-pr/13745/docs/dev/index.html |
| Developer documentation | ||
| ----------------------- | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| dev/index |
There was a problem hiding this comment.
I could go either way on this ultimately, but my suggestion from before was to make this hidden, and then just have a direct link to the dev docs root from our README. I think this would avoid polluting the end-user docs with dev docs while still allowing cross linking.
There was a problem hiding this comment.
at least with the redirects plugin in we have now this is not possible, and wouldnt be without quite a lot of hackery
i searched again today to see if there was anything like a "split-tree" rendering in sphinx and turned up nothing
i think to go the way you suggest is fighting the system too much, altho i guess its theoretically possible
There was a problem hiding this comment.
OK it's not a big deal. Maybe just set max depth to 1 or something so not much shows up in the main index?
|
This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions! |
github-actions
bot
added
the
stale
mattklein123
removed
the
stale
|
This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions! |
github-actions
bot
added
the
stale
|
bump |
github-actions
bot
removed
the
stale
|
This pull request has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed in 7 days if no further activity occurs. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions! |
github-actions
bot
added
the
stale
|
This pull request has been automatically closed because it has not had activity in the last 37 days. Please feel free to give a status update now, ping for review, or re-open when it's ready. Thank you for your contributions! |
Signed-off-by: Ryan Northey ryan@synca.io
Commit Message: docs: Add developers section to docs
Additional Description:
This is currently very WIP, and the focus is mostly on figuring out a rough structure for dev docs atm...
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue] Fix #13431
[Optional Deprecated:]