-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add Section for Docs regarding SCS Developers #81
Conversation
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
Signed-off-by: Max Wolfs <[email protected]>
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.
Will this lead to 404 errors?
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.
It would yes, but those two documents/pages have not been listed anywhere on the docs page yet.
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 was actually more worried about links from outside (eg. blogposts, other docs). I grepped through our stuff and didn't find any references. imho good to go. 👍🏻
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.
LGTM - please see question regarding the filename change.
Signed-off-by: Christian Berendt <[email protected]>
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'm probably not perfectly qualified to do a full featured review on this topic.
LGTM as far as i can tell.
Adding Zuul quickstart guide to dev-docs works for me.
Is there a task left for me regarding the quick start guide?
Yes, once this is merged the zuul quickstart guide has to be moved to dev-docs then. |
Signed-off-by: Max Wolfs <[email protected]>
I did it now within the last commit. |
This PR adds a second section for documentation regarding the development of SCS, especially targeting SCS Developers. This makes it easier to distinguish between the target groups / roles of Operators and Developers. The main
docs
path in the files system, is for the operator docs. The developer docs are 'dev-docs'. This is reflected in the urls and routing.Currently there are only two IAM documents, where there is still the question if they aren't part of the standards drafts? see #72 @reqa
The SCS Zuul User Docs should also reside in the path of
dev-docs
.Additionally the main nav is now directly addressing the roles / personas.
This will make it easier to set up the
index
page of https://docs.scs.community where we – SIG Documentation – want to establish starting points for the different site sections.Thanks @fkr for the nice session!