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.

Sign up for GitHub

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

Jump to bottom

Sphinxify all docs #39

Closed
junr03 opened this issue Jun 6, 2019 · 3 comments · Fixed by #64
Closed

Sphinxify all docs #39

junr03 opened this issue Jun 6, 2019 · 3 comments · Fixed by #64
Assignees
@rebello95
Labels
docs
Milestone
v0.1 "Antipasto"

Comments

@junr03
Copy link
Member

junr03 commented Jun 6, 2019

We have decided to have all documentation in sphinx.
@junr03 junr03 added the docs label Jun 6, 2019
@junr03 junr03 added this to the v0.1 "Antipasto" milestone Jun 6, 2019
@junr03
Copy link
Member Author

junr03 commented Jun 6, 2019

Some sections that we should populate:

  1. Overview of the examples
  2. Build requirements: NKD, Bazel, OS versions, etc.

@rebello95 rebello95 self-assigned this Jun 7, 2019
rebello95 added a commit that referenced this issue Jun 11, 2019
@rebello95
docs: add docs for building and examples
f167bde 
Resolves #39, #32, and #33.

Signed-off-by: Michael Rebello <[email protected]>
@rebello95 rebello95 mentioned this issue Jun 11, 2019
Merged
@rebello95
Copy link
Contributor

#64

Going to close out this issue after the above PR merges. We will still have #37 open for adding inline documentation, and we can open separate issues for documenting other specific pieces if need be

@rebello95
Copy link
Contributor

#43 is also still around to track build documentation

rebello95 added a commit that referenced this issue Jun 13, 2019
@rebello95
docs: add docs for building and examples (#64)
8141766 
Resolves #39, #32, and #33.

Signed-off-by: Michael Rebello <[email protected]>
@Augustyniak Augustyniak mentioned this issue Nov 2, 2022
Closed
jpsim pushed a commit to envoyproxy/envoy that referenced this issue Nov 28, 2022
@rebello95 @jpsim
docs: add docs for building and examples (#64)
c8c97e2 
Resolves envoyproxy/envoy-mobile#39, envoyproxy/envoy-mobile#32, and envoyproxy/envoy-mobile#33.

Signed-off-by: Michael Rebello <[email protected]>
Signed-off-by: JP Simard <[email protected]>
jpsim pushed a commit to envoyproxy/envoy that referenced this issue Nov 29, 2022
@rebello95 @jpsim
docs: add docs for building and examples (#64)
afece95 
Resolves envoyproxy/envoy-mobile#39, envoyproxy/envoy-mobile#32, and envoyproxy/envoy-mobile#33.

Signed-off-by: Michael Rebello <[email protected]>
Signed-off-by: JP Simard <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rebello95 rebello95

Labels
docs
Projects
None yet
Milestone
v0.1 "Antipasto"
Development

Successfully merging a pull request may close this issue.

docs: add docs for building and examples envoyproxy/envoy-mobile
2 participants
@rebello95 @junr03