Infrastructure/infra-docs-fpo
1
0
Fork 0
Code Issues 100 Pull requests 6 Projects Releases Packages Wiki Activity Actions

Change the structure of the documentation

Browse source 
* Move everything to one navigation file. This should help with navigation on the
page.
* Rename the docs to Fedora Infrastructure & Release Engineering
* Change the structure so the infrastructure and release engineering docs are
better separated

Signed-off-by: Michal Konecny <mkonecny@redhat.com>
This commit is contained in:
Michal Konecny 2024-03-11 13:45:45 +01:00 • committed by zlopez
parent 381b22bdd6
commit 7b5867070a
6 changed files with 70 additions and 74 deletions
Download patch file Download diff file Expand all files Collapse all files

6
antora.yml
View file

@ -5,7 +5,7 @@
name: infra
# Title will be visible on the page.
title: Fedora Infrastructure
title: Fedora Infrastructure & Release Engineering
# If you don't plan to have multiple versions of the docs (for example, to
# document multiple versions of some software), you can ignore this field.
@ -20,7 +20,3 @@ start_page: ROOT:index.adoc
# This lists all the menu definitions of your component.
nav:
- modules/ROOT/nav.adoc
- modules/developer_guide/nav.adoc
- modules/sysadmin_guide/nav.adoc
- modules/release_guide/nav.adoc
- modules/releng_misc_guide/nav.adoc

86
modules/ROOT/nav.adoc
View file

@ -1,17 +1,69 @@
* xref:overview.adoc[A global overview]
* xref:day_to_day_fedora.adoc[Working with Fedora Infrastructure]
* xref:join.adoc[Join the team]
** xref:gettingstarted.adoc[Getting Started with Infrastructure]
** xref:apprentice.adoc[Infrastructure Apprentice Progam]
* xref:map_critical_services.adoc[Map of critical services]
* xref:services.adoc[List of our services]
** xref:services.adoc#_accounts[Account management]
** xref:services.adoc#_community[Community apps]
** xref:services.adoc#_content_documentation[Content & documentation]
** xref:services.adoc#_coordination[Coordination]
** xref:services.adoc#_packaging[Packager tools]
** xref:services.adoc#_qa[QA tools]
** xref:services.adoc#_misc[Miscellaneous]
** xref:sle.adoc[SLE]
*** xref:sle_services.adoc[SLE of the services]
* xref:communishift.adoc[Communishift]
* xref:overview.adoc[Fedora Infrastructure]
** xref:day_to_day_fedora.adoc[Working with Fedora Infrastructure]
** xref:join.adoc[Join the team]
*** xref:gettingstarted.adoc[Getting Started with Infrastructure]
*** xref:apprentice.adoc[Infrastructure Apprentice Progam]
** xref:map_critical_services.adoc[Map of critical services]
** xref:services.adoc[List of our services]
*** xref:services.adoc#_accounts[Account management]
*** xref:services.adoc#_community[Community apps]
*** xref:services.adoc#_content_documentation[Content & documentation]
*** xref:services.adoc#_coordination[Coordination]
*** xref:services.adoc#_packaging[Packager tools]
*** xref:services.adoc#_qa[QA tools]
*** xref:services.adoc#_misc[Miscellaneous]
*** xref:sle.adoc[SLE]
**** xref:sle_services.adoc[SLE of the services]
** xref:communishift.adoc[Communishift]
** xref:developer_guide:index.adoc[Developer Guide]
*** xref:developer_guide:getting-started.adoc[Getting Started]
*** xref:developer_guide:dev-environment.adoc[Development Environment]
*** xref:developer_guide:documentation.adoc[Documentation]
*** xref:developer_guide:code-style.adoc[Code Style]
*** xref:developer_guide:frameworks.adoc[Frameworks and Tools]
*** xref:developer_guide:db.adoc[Databases]
*** xref:developer_guide:writing-tests.adoc[Tests]
*** xref:developer_guide:ci.adoc[CI]
*** xref:developer_guide:auth.adoc[Authentication]
*** xref:developer_guide:messaging.adoc[Messaging]
*** xref:developer_guide:sops.adoc[Developing Standard Operating Procedures]
*** xref:developer_guide:source_control.adoc[Source Control]
*** xref:developer_guide:openshift.adoc[Openshift]
*** xref:developer_guide:security_policy.adoc[Fedora Infrastructure Application Security Policy]
** xref:sysadmin_guide:index.adoc[Sysadmin Guide]
*** xref:sysadmin_guide:orientation.adoc[Orientation for Sysadmin Guide]
*** xref:sysadmin_guide:index.adoc#_standard_operating_procedures[Standard Operation Procedures]
*** xref:sysadmin_guide:index.adoc#_howtos[HOWTOs]
* xref:release_guide:index.adoc[Release Engineering]
** xref:release_guide:release_process.adoc[Release process]
*** xref:release_guide:mass_rebuild.adoc[Mass Rebuild]
*** xref:release_guide:sop_file_ftbfs.adoc[File FTBFS bugs]
*** xref:release_guide:mass_branching_checklist.adoc[Mass Branching Checklist]
*** xref:release_guide:sop_mass_branching.adoc[Mass Branching]
*** xref:release_guide:sop_bodhi_activation.adoc[Updates testing activation]
*** xref:release_guide:beta_freeze.adoc[Beta freeze]
*** xref:release_guide:beta_RC_compose.adoc[Beta RC compose]
*** xref:release_guide:beta_release.adoc[Beta release]
*** xref:release_guide:final_freeze.adoc[Final freeze]
*** xref:release_guide:final_RC_compose.adoc[Final RC compose]
*** xref:release_guide:final_release.adoc[Final release]
*** xref:release_guide:release_eol.adoc[End Of Life]
*** xref:release_guide:torrentrelease.adoc[Torrent releases]
** xref:releng_misc_guide:index.adoc[Releng Miscellaneous guide]
*** xref:releng_misc_guide:sop_generating_openh264_composes.adoc[Generate openh264 composes]
*** xref:releng_misc_guide:sop_eol_change.adoc[Adjust EOLs and SLs on branches]
*** xref:releng_misc_guide:sop_fedora_media_writer.adoc[Fedora Media Writer Building and Signing]
*** xref:releng_misc_guide:sop_find_module_info.adoc[Find Module Information]
*** xref:releng_misc_guide:sop_unretire.adoc[Unretire package branch]
*** xref:releng_misc_guide:sop_update_critpath.adoc[Update Critpath]
*** xref:releng_misc_guide:sop_remote_dist_git_branches.adoc[Remove dist-git branches]
*** xref:releng_misc_guide:sop_package_unblocking.adoc[Package Unblocking]
*** xref:releng_misc_guide:sop_retire_orphaned_packages.adoc[Retire Orphaned Packages]
*** xref:releng_misc_guide:sop_requesting_task_automation_users.adoc[Requesting Automation Users]
*** xref:releng_misc_guide:sop_process_dist_git_requests.adoc[Process fedora-scm-requests tickets]
*** xref:releng_misc_guide:sop_signing_builds.adoc[Sign the packages]
*** xref:releng_misc_guide:sop_clean_amis.adoc[Clean AMIs Process]
*** xref:releng_misc_guide:sop_pushing_updates.adoc[Pushing Updates]
*** xref:releng_misc_guide:sop_package_blocking.adoc[Package Blocking]
*** xref:releng_misc_guide:sop_sigul_client_setup.adoc[Sigul Client Setup]
** xref:releng_misc_guide:troubleshooting.adoc[Fedora Release Engineering Troubleshooting Guide]

15
modules/developer_guide/nav.adoc
View file

@ -1,15 +0,0 @@
* xref:index.adoc[Developer Guide]
** xref:getting-started.adoc[Getting Started]
** xref:dev-environment.adoc[Development Environment]
** xref:documentation.adoc[Documentation]
** xref:code-style.adoc[Code Style]
** xref:frameworks.adoc[Frameworks and Tools]
** xref:db.adoc[Databases]
** xref:writing-tests.adoc[Tests]
** xref:ci.adoc[CI]
** xref:auth.adoc[Authentication]
** xref:messaging.adoc[Messaging]
** xref:sops.adoc[Developing Standard Operating Procedures]
** xref:source_control.adoc[Source Control]
** xref:openshift.adoc[Openshift]
** xref:security_policy.adoc[Fedora Infrastructure Application Security Policy]

15
modules/release_guide/nav.adoc
View file

@ -1,15 +0,0 @@
* xref:index.adoc[Release guide]
* xref:release_process.adoc[Release process]
** xref:mass_rebuild.adoc[Mass Rebuild]
** xref:sop_file_ftbfs.adoc[File FTBFS bugs]
** xref:mass_branching_checklist.adoc[Mass Branching Checklist]
** xref:sop_mass_branching.adoc[Mass Branching]
** xref:sop_bodhi_activation.adoc[Updates testing activation]
** xref:beta_freeze.adoc[Beta freeze]
** xref:beta_RC_compose.adoc[Beta RC compose]
** xref:beta_release.adoc[Beta release]
** xref:final_freeze.adoc[Final freeze]
** xref:final_RC_compose.adoc[Final RC compose]
** xref:final_release.adoc[Final release]
** xref:release_eol.adoc[End Of Life]
** xref:torrentrelease.adoc[Torrent releases]

18
modules/releng_misc_guide/nav.adoc
View file

@ -1,18 +0,0 @@
* xref:index.adoc[Releng Miscellaneous guide]
** xref:sop_generating_openh264_composes.adoc[Generate openh264 composes]
** xref:sop_eol_change.adoc[Adjust EOLs and SLs on branches]
** xref:sop_fedora_media_writer.adoc[Fedora Media Writer Building and Signing]
** 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_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]
** xref:sop_requesting_task_automation_users.adoc[Requesting Automation Users]
** xref:sop_process_dist_git_requests.adoc[Process fedora-scm-requests tickets]
** xref:sop_signing_builds.adoc[Sign the packages]
** xref:sop_clean_amis.adoc[Clean AMIs Process]
** xref:sop_pushing_updates.adoc[Pushing Updates]
** xref:sop_package_blocking.adoc[Package Blocking]
** xref:sop_sigul_client_setup.adoc[Sigul Client Setup]
* xref:troubleshooting.adoc[Fedora Release Engineering Troubleshooting Guide]

4
modules/sysadmin_guide/nav.adoc
View file

@ -1,4 +0,0 @@
* xref:orientation.adoc[Orientation for Sysadmin Guide]
* xref:index.adoc[Sysadmin Guide]
** xref:index.adoc#_standard_operating_procedures[Standard Operation Procedures]
** xref:index.adoc#_howtos[HOWTOs]