Skip to content

fix(quay-docs):Remove commented-out 3.0-master downstream section from README.adoc #1783

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

Merged
stevsmit merged 1 commit into from
Aug 31, 2026
Merged

fix(quay-docs):Remove commented-out 3.0-master downstream section from README.adoc #1783

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
43 changes: 0 additions & 43 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: REFERENCE

= Contributing to Red Hat Quay documentation

Check warning on line 3 in README.adoc

View workflow job for this annotation

GitHub Actions / vale

Vale: AsciiDocDITA.ShortDescription 

Assign [role="_abstract"] to a paragraph to use it as <shortdesc> in DITA.

Check warning on line 3 in README.adoc

View workflow job for this annotation

GitHub Actions / vale

Vale: AsciiDocDITA.DocumentId 

The document ID assigned to the level 0 (=) heading is missing.
:downstream:

== Repository structure
Expand Down Expand Up @@ -102,7 +102,7 @@

To make a contribution to upstream documentation, follow the instructions at <<how-do-i-make-a-contribution>>. Be sure to work with the documentation lead for Red Hat Quay to get the content reviewed, merged, and published on the downstream portal.

=== How Red Hat Quay downstream documentation is branched

Check failure on line 105 in README.adoc

View workflow job for this annotation

GitHub Actions / vale

Vale: AsciiDocDITA.NestedSection 

Level 2, 3, 4, and 5 sections (=== and deeper) are not supported in DITA.

After you have created and merged a pull request, relevant branches are then reset to match the `master` branch. For example, if the current version of Red Hat Quay is 3.10, then the relevant 3.10 branch (`redhat-3.10`) is reset to match the `master`. branch. This ensures that the most recent content changes are up to date in the most recent version branch.

Expand Down Expand Up @@ -163,49 +163,6 @@
$ git push --force origin <feature_branch>
----

ifdef::downstream[]

////
[id="how-do-i-keep-the-downstream-repository-and-branch-up-to-date"]
== How do I keep the downstream repository and branch up-to-date?

To bring the https://gitlab.cee.redhat.com/red-hat-quay-documentation/quay-documentation/[downstream repository] up-to-date with the upstream repository, you need to push the changes to the `3.0-master` branch of the downstream repository and merge `3.0-master` into `3.0-stage`, from which downstream documentation is published:

. Update your local `3.0-master` branch. <<how-do-i-keep-my-local-3.0-master-up-to-date-with-remote-3.0-master>>

. Switch to the `3.0-master` branch:
+
----
$ git checkout 3.0-master
----

. Push `3.0-master` to the downstream repository:
+
----
$ git push downstream
----

. Switch to the `3.0-stage` branch:
+
----
$ git checkout 3.0-stage
----

. Merge `3.0-master` into `3.0-stage`:
+
----
$ git merge 3.0-master
----

. Push `3.0-stage` to the downstream repository:
+
----
$ git push downstream
----

endif::downstream[]
////

== How do I make content appear in upstream but not in downstream?

You can make content appear only in the upstream by using the `ifdef::upstream` conditional around the content that you only want to appear upstream. For example:
Expand Down
Loading