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.

Sign up for GitHub

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 readme to remove special branch instructions #140

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

update readme to remove special branch instructions #140

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ Always update the openshift docset when there is a new gpu-operator docset versi

Changes to the default branch are not published on docs.nvidia.com.

Only tags or specially-named branches are published to docs.nvidia.com.
Only tags are published to docs.nvidia.com.

1. Create a tag or specially-named branch from your commit with the following naming pattern: `<component-name>-v<version>`.
1. Create a tag from your commit with the following naming pattern: `<component-name>-v<version>`.

*Example*

Expand All @@ -156,7 +156,7 @@ Only tags or specially-named branches are published to docs.nvidia.com.

Always tag the openshift docset and driver-containers docset for each new gpu-operator docset release.

1. Push the tag or specially-named branch to the repository.
1. Push the tag to the repository.

CI builds the documentation for the Git ref---currently for all software components.
However, only the documentation for the `component-name` and specified version is updated on the web.
Expand Down
Loading