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.

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

Merged
merged 6 commits into from
Sep 29, 2023
Merged

Conversation

maxwolfs
Copy link
Member

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!

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]>
Copy link
Member

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?

Copy link
Member Author

@maxwolfs maxwolfs Sep 27, 2023

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.

Copy link
Member

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. 👍🏻

Copy link
Member

@fkr fkr left a 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.

master-caster pushed a commit that referenced this pull request Sep 28, 2023
Copy link
Contributor

@master-caster master-caster left a 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?

@maxwolfs
Copy link
Member Author

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]>
@maxwolfs
Copy link
Member Author

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.

I did it now within the last commit.

@maxwolfs maxwolfs merged commit b034e08 into main Sep 29, 2023
4 checks passed
@maxwolfs maxwolfs deleted the feat/add-dev-docs branch September 29, 2023 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants