Skip to content

README: clarify documentation update after a new release#200

Merged
jrha merged 3 commits intoquattor:masterfrom
jouvin:release_doc
May 21, 2018
Merged

README: clarify documentation update after a new release#200
jrha merged 3 commits intoquattor:masterfrom
jouvin:release_doc

Conversation

@jouvin
Copy link
Contributor

@jouvin jouvin commented Apr 25, 2018

No description provided.

@jouvin jouvin requested review from jrha and stdweird April 25, 2018 15:48
README.md Outdated
of the `Settings` page access through the `Admin` button of the project home page).
Once added it will build automatically. The default version displayed on
ReadTheDocs is normally `stable` which will automatically mapped to the new version
once it is built (if it is the highest tag). You can also explicitely select the version
Copy link
Member

Choose a reason for hiding this comment

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

explicitely -> explicitly

@jouvin jouvin mentioned this pull request Apr 25, 2018
3 tasks
README.md Outdated
release. Once added it will build automatically. You can then select
the latest release as the default version to show.
After producing the release, the documentation on ReadTheDocs (RTD) must be updated,
as RTD currently does not build automatically new versions.
Copy link
Member

Choose a reason for hiding this comment

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

does not automatically build new versions

README.md Outdated
Before doing anything else, ensure that the release notes and the change
log for the release are up to date and complete. The source is in the
Before doing anything else, **ensure that the release notes and the change
log for the release are up to date and complete**. The source is in the
Copy link
Member

Choose a reason for hiding this comment

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

What is meant by "complete" here?

README.md Outdated
the latest release as the default version to show.
After producing the release, the documentation on ReadTheDocs (RTD) must be updated,
as RTD currently does not build automatically new versions.
You must log into ReadTheDocs.org with an account who is
Copy link
Member

Choose a reason for hiding this comment

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

with an account who is

Once added it will build automatically. The default version displayed on
ReadTheDocs is normally `stable` which will automatically mapped to the new version
once it is built (if it is the highest tag). You can also explicitly select the version
to show on lower-left corner.
Copy link
Member

Choose a reason for hiding this comment

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

This is a per-user-session setting though…

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No this is part of the project settings... A user can change this but the default is really stable...

Copy link
Member

Choose a reason for hiding this comment

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

Oh I see, you mean that the project admins can change which value appears there by default.

jrha and others added 2 commits May 15, 2018 15:16
I keep forgetting this step.
Document upload of RPMs to repository server
@jouvin
Copy link
Contributor Author

jouvin commented May 21, 2018

@jrha I suggest that your merge it!

@jrha jrha merged commit 4164186 into quattor:master May 21, 2018
@jrha jrha added this to the 10.8 milestone Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants