releng SOPs misc: drop dead pages, link sigul SOP, clean up template
There's currently an `sop.adoc` page which looks like a bad wiki conversion of a list of links to the miscellaneous SOPs. We already have `index.adoc` as a *working* list of links to the miscellaneous SOPs, so this is pretty redundant, let's just drop it. Also dropped: sop_update_releng_docs , which is entirely outdated. Also, make `index.adoc` and the nav sidebar link to the sigul client setup SOP which they're currently missing, and update the SOP template page a bit. Signed-off-by: Adam Williamson <awilliam@redhat.com>
This commit is contained in:
Adam Williamson
parent
b21d32f2c1
commit
24ed33ef98
5 changed files with 6 additions and 112 deletions
|
|
@ -5,7 +5,6 @@
|
|||
** xref:sop_find_module_info.adoc[Find Module Information]
|
||||
** xref:sop_unretire.adoc[Unretire package branch]
|
||||
** xref:sop_update_critpath.adoc[Update Critpath]
|
||||
** xref:sop_update_releng_docs.adoc[Update RelEng Rendered Docs]
|
||||
** xref:sop_remote_dist_git_branches.adoc[Remove dist-git branches]
|
||||
** xref:sop_package_unblocking.adoc[Package Unblocking]
|
||||
** xref:sop_retire_orphaned_packages.adoc[Retire Orphaned Packages]
|
||||
|
|
@ -15,5 +14,5 @@
|
|||
** xref:sop_clean_amis.adoc[Clean AMIs Process]
|
||||
** xref:sop_pushing_updates.adoc[Pushing Updates]
|
||||
** xref:sop_package_blocking.adoc[Package Blocking]
|
||||
* xref:sop.adoc[Fedora Release Engineering Standard Operating Procedures]
|
||||
* xref:troubleshooting.adoc[Fedora Release Engineering Troubleshooting Guide]
|
||||
** xref:sop_sigul_client_setup.adoc[Sigul Client Setup]
|
||||
* xref:troubleshooting.adoc[Fedora Release Engineering Troubleshooting Guide]
|
||||
|
|
|
|||
|
|
@ -18,7 +18,6 @@ Here are some of the miscellaneous tasks performed by the Fedora Release Enginee
|
|||
* link:sop_find_module_info[Find Module Information]
|
||||
* link:sop_unretire[Unretire package branch]
|
||||
* link:sop_update_critpath[Update Critpath]
|
||||
* link:sop_update_releng_docs[Update RelEng Rendered Docs]
|
||||
* link:sop_remote_dist_git_branches[Remove dist-git branches]
|
||||
* link:sop_package_unblocking[Package Unblocking]
|
||||
* link:sop_retire_orphaned_packages[Retire Orphaned Packages]
|
||||
|
|
@ -28,6 +27,7 @@ Here are some of the miscellaneous tasks performed by the Fedora Release Enginee
|
|||
* link:sop_clean_amis[Clean AMIs Process]
|
||||
* link:sop_pushing_updates[Pushing Updates]
|
||||
* link:sop_package_blocking[Package Blocking]
|
||||
* link:sop_sigul_client_setup[Sigul Client Setup]
|
||||
|
||||
== Conclusion ==
|
||||
|
||||
|
|
|
|||
|
|
@ -1,48 +0,0 @@
|
|||
[[sop]]
|
||||
== Fedora Release Engineering Standard Operating Procedures
|
||||
|
||||
This page documents the Standard Operating Procedures for Fedora Release
|
||||
Engineering.
|
||||
|
||||
=== Purpose
|
||||
|
||||
The SOP section contains a list of tasks Fedora Release Engineering team
|
||||
provides for the project. Current Fedora Release Engineering team
|
||||
members would can add tasks they know about and list steps to complete
|
||||
the task as well as issues to consider. This is a great way to make sure
|
||||
that individuals aren't the only ones that can fix a problem.
|
||||
|
||||
=== The Community
|
||||
|
||||
The SOP section is left in the public because it is our hope that others
|
||||
in the community will add common problems, fix our steps and just in
|
||||
general look over what we're doing and help us when we're doing
|
||||
something stupid. We encourage anyone interested to go over our
|
||||
processes with a fine tooth comb. It'll make us better and we'll
|
||||
probably learn something in the process. Therefore please open a
|
||||
https://pagure.io/releng/pull-requests[pull request] to suggest
|
||||
improvements.
|
||||
|
||||
=== Procedures
|
||||
|
||||
Needed: #. Composing an official release #. Making a composed release
|
||||
publicly available
|
||||
|
||||
=== Standard Operating Procedures
|
||||
|
||||
sop_adding_build_targets sop_adding_content_generator
|
||||
sop_adding_new_release_engineer sop_adding_new_branch_sla
|
||||
sop_adding_packages_compose_artifact sop_adding_side_build_targets
|
||||
sop_branch_freeze sop_branching sop_breaking_development_freeze
|
||||
sop_composing_fedora sop_clean_amis sop_create_release_signing_key
|
||||
sop_deprecate_ftbfs_packages sop_end_of_life sop_eol_change
|
||||
sop_mass_branching sop_bodhi_activation sop_mass_rebuild_packages
|
||||
sop_mass_rebuild_modules sop_file_ftbfs sop_generating_openh264_composes
|
||||
sop_package_blocking sop_package_unblocking
|
||||
sop_process_dist_git_requests sop_promoting_container_content
|
||||
sop_signing_builds sop_pushing_updates sop_release_package_signing
|
||||
sop_remote_dist_git_branches sop_requesting_task_automation_users
|
||||
sop_retire_orphaned_packages sop_sigul_client_setup
|
||||
sop_stage_final_release_for_mirrors sop_unretire sop_update_critpath
|
||||
sop_update_releng_docs sop_updating_comps sop_fedora_media_writer
|
||||
sop_find_module_info sop_release_container_base_image
|
||||
|
|
@ -3,14 +3,11 @@
|
|||
[NOTE]
|
||||
.Note
|
||||
====
|
||||
This is a template file, this can be copied to a new filename in order
|
||||
to start a new document.
|
||||
This is a template file, this can be copied to a new filename in order to start a new SOP.
|
||||
|
||||
New SOP Documents should be added to the `.. toctree::` list in the
|
||||
`sop.rst` file.
|
||||
New SOP documents should be added to the appropriate place in this repo - if they do not fit anywhere else, they go in this releng_misc_guide, linked from pages/index.adoc and nav.adoc.
|
||||
|
||||
These documents are formatted using sphinx-doc reStructure Text, for
|
||||
markup reference please see: http://sphinx-doc.org/rest.html
|
||||
These documents are formatted using AsciiDoc, for markup reference please see: xref:fedora-docs:contributing-docs/asciidoc-markup.adoc[these docs]
|
||||
====
|
||||
|
||||
=== Description
|
||||
|
|
|
|||
|
|
@ -1,54 +0,0 @@
|
|||
== Update RelEng Rendered Docs
|
||||
|
||||
=== Description
|
||||
|
||||
When an improvement happens to the Release Engineering documentation
|
||||
following the `contributing <contributing>` for the
|
||||
http://sphinx-doc.org/[Sphinx]
|
||||
https://en.wikipedia.org/wiki/ReStructuredText[reStructured Text] source
|
||||
found in `docs/source` within the https://pagure.io/releng[RelEng git
|
||||
repository] someone has to manually perform a process in order to update
|
||||
the documentation that is hosted in the https://pagure.io/pagure[pagure]
|
||||
documentation space for https://docs.pagure.org/releng/[Fedora RelEng
|
||||
docs].
|
||||
|
||||
=== Action
|
||||
|
||||
In order to render the documentation using
|
||||
http://sphinx-doc.org/[Sphinx], you need to first be sure to have the
|
||||
package installed:
|
||||
|
||||
....
|
||||
$ dnf install python-sphinx
|
||||
....
|
||||
|
||||
Then we'll need to clone the RelEng repository and the RelEng docs
|
||||
repository (the docs git repository is provided by pagure
|
||||
automatically). There is a script in the [.title-ref]#releng# repository
|
||||
that takes care of cleanly updating the documentation site for us.
|
||||
|
||||
....
|
||||
$ ./scripts/update-docs.sh
|
||||
....
|
||||
|
||||
The documentation is now live.
|
||||
|
||||
[NOTE]
|
||||
.Note
|
||||
====
|
||||
This will require someone with permissions to push to the rawhide branch
|
||||
for the releng repository. If you are curious whom all has this ability,
|
||||
please refer to the `Main Page <index>` and contact someone from the
|
||||
"Team Composition"
|
||||
====
|
||||
|
||||
=== Verification
|
||||
|
||||
Visit the https://docs.pagure.org/releng/[Fedora RelEng docs] website
|
||||
and verify that the changes are reflected live on the docs site.
|
||||
|
||||
=== Consider Before Running
|
||||
|
||||
No considerations at this time. The docs git repository is simply a
|
||||
static html hosting space and we can just re-render the docs and push to
|
||||
it again if necessary.
|
||||
Loading…
Add table
Add a link
Reference in a new issue