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 simple configuration guides for all supported OpenStack services #398

Merged
merged 1 commit into from
Apr 2, 2024

Conversation

janhorstmann
Copy link
Contributor

@janhorstmann
Copy link
Contributor Author

I have taken the list of supported services from the release respository version 7.0.0

Do you want to keep the links currently used in the nova docs or want it to be more uniform?

The skyline-apiserver project seems not to have an admin guide, so I have not added a link

@janhorstmann janhorstmann requested a review from berendt March 27, 2024 15:11
@berendt
Copy link
Member

berendt commented Mar 27, 2024

Use a single skyline file and add console & api server there.

Add additional neutron services (dynamic routing, vpnaas) to the neutron file and not in separate files.

@berendt
Copy link
Member

berendt commented Mar 27, 2024

Always add a link (if it exists) to the configuration reference (like https://docs.openstack.org/nova/latest/configuration/config.html) as well.

@berendt
Copy link
Member

berendt commented Mar 27, 2024

For some services the configuration guide is the same like the configuration reference. In this case only add a single link and name it configuration reference.

The configuration reference is the page of all usable configuration parameters.

The configuration guide explains how to configure specific features.

Copy link
Member

@berendt berendt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As commented before.

@janhorstmann
Copy link
Contributor Author

For some services the configuration guide is the same like the configuration reference. In this case only add a single link and name it configuration reference.

The configuration reference is the page of all usable configuration parameters.

The configuration guide explains how to configure specific features.

Some services have sites titled "configuration guide", which only link to the configuration reference of one or more applications. Ich have included those as "configuration reference" now, because they do not provide any further guidance, but the mismatch might be irritating for some.

@janhorstmann janhorstmann requested a review from berendt March 28, 2024 13:48
@janhorstmann janhorstmann marked this pull request as ready for review April 2, 2024 16:33
@janhorstmann janhorstmann requested a review from berendt April 2, 2024 16:39
@berendt berendt merged commit b7cf903 into main Apr 2, 2024
3 checks passed
@berendt berendt deleted the gh938 branch April 2, 2024 17:12
scoopex pushed a commit that referenced this pull request May 21, 2024
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.

2 participants