-
Notifications
You must be signed in to change notification settings - Fork 211
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
Update product name and doc structure #9
Conversation
@rfratto I've got some conflicts in |
@clayton-cornell When you're trying to merge |
@clayton-cornell Also when you merge this PR, make sure you're using |
@rfratto Thanks that tip got me moving with fixing things. I also had to modify The doc source changes are too big to check. I've ran local doc builds and made sure the docs build without errors.. so should be good as a solid base to iterate on. |
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.
Yeah pages look fine at a scan. Let me know if there's anything specific you'd like me to check. Otherwise we can get this in and iterate in smaller chunks.
I'm going to merge.. the two Go files I touched need a major rework anyway. I changed two lines to get the docs to build. It's not in the core product, and it's given me a green build. |
PR Description
This PR does the following:
flow
from doc pathMakefile
andvariables.mk
files somake docs
will build a local version of the docs_index.md
to combine some info that was split in the old repo. (currently disconnected from the generated template topic)docs/reference
is removed and in its place we use relative URIs. This simplifies the linking within the doc tree and will work in both OSS and Cloud doc mountsWhich issue(s) this PR fixes
Notes to the Reviewer
PR Checklist