-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
[WIP] docs: Add developers section to docs #13745
Closed
Closed
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
dc09ed9
docs: Add developers section to docs
phlax 179e14b
docs/
phlax 04e3671
docs/
phlax 5bc15ed
docs/
phlax 26a1ce3
docs/
phlax 9ceee9c
docs/
phlax 98a59e0
docs/
phlax b5866b2
docs/
phlax e6d15b9
docs/
phlax bc3fd3e
docs/
phlax File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
|
||
Envoy build documentation | ||
========================= | ||
|
||
native building | ||
--------------- | ||
|
||
using build container (amd64/arm64) | ||
----------------------------------- | ||
|
||
build operations | ||
---------------- | ||
|
||
bazel survival guide | ||
-------------------- | ||
|
||
dependency policies | ||
------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Envoy developer community | ||
========================= | ||
|
||
contrib guidelines | ||
------------------ | ||
|
||
repokitteh | ||
---------- | ||
|
||
devstats | ||
-------- | ||
|
||
slack channels | ||
-------------- | ||
|
||
github | ||
------ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Envoy core documentation | ||
======================== | ||
|
||
Core or extension? | ||
------------------ | ||
|
||
API policies | ||
------------ | ||
|
||
testing policies - unit/integration/coverage | ||
-------------------------------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Writing docs | ||
============ | ||
|
||
API documentation | ||
----------------- | ||
|
||
Configuration documentation | ||
--------------------------- | ||
|
||
Creating a sandbox | ||
------------------ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Envoy extensions documentation | ||
============================== | ||
|
||
types of extension | ||
------------------ | ||
|
||
writing extensions | ||
------------------ | ||
|
||
deploying extensions | ||
-------------------- | ||
|
||
publishing extensions | ||
--------------------- | ||
|
||
existing extensions | ||
------------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
Developer documentation | ||
----------------------- | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
community/index | ||
build/index | ||
testing/index | ||
core/index | ||
extensions/index | ||
docs/index | ||
standards/index |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
|
||
Code standards, linting, and style guides | ||
========================================= | ||
|
||
c++ | ||
--- | ||
|
||
python | ||
------ | ||
|
||
starlark | ||
-------- | ||
|
||
bazel | ||
----- | ||
|
||
bash | ||
---- | ||
|
||
docs/rst | ||
-------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
|
||
Envoy testing documentation | ||
=========================== | ||
|
||
|
||
running tests | ||
------------- | ||
|
||
writing tests | ||
------------- | ||
|
||
coverage | ||
-------- | ||
|
||
config_validation | ||
----------------- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yep, sgtm