From 1d717bf812e4134c75539e14ed4905e0d46eef52 Mon Sep 17 00:00:00 2001 From: Jiri Konecny Date: Fri, 20 Dec 2024 13:01:36 +0100 Subject: [PATCH 1/4] Ignore docs/html directory by git These are generated files. --- docs/.gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/.gitignore b/docs/.gitignore index 278bdab9909..c6a4e9a51a5 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,3 @@ api kickstart-docs.* +html/ From 7dcf03578ef8fd8208fc72078aa02369bac89c66 Mon Sep 17 00:00:00 2001 From: Jiri Konecny Date: Fri, 20 Dec 2024 13:03:58 +0100 Subject: [PATCH 2/4] Ignore docs/contributing.rst by git This file is copied from CONTRIBUTING.rst project root directory. We don't want to modify the copied content. --- docs/.gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/.gitignore b/docs/.gitignore index c6a4e9a51a5..05f04d2b55a 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,3 +1,4 @@ api kickstart-docs.* html/ +contributing.rst From 58715e235416e7af12c347f47be720c715e29cf0 Mon Sep 17 00:00:00 2001 From: Jiri Konecny Date: Fri, 20 Dec 2024 13:05:29 +0100 Subject: [PATCH 3/4] Move docs advanced topics into new subsection Currently everything is in one level when you open the Anaconda documentation. There is a lot of topics. Let's make the documentation a bit more structured. Adding developer directory but also a page with this content so it is more hidden. --- docs/developer.rst | 20 ++++++++++++++++++++ docs/{ => developer}/commit-log.rst | 0 docs/{ => developer}/configuration-files.rst | 0 docs/{ => developer}/driverdisc.rst | 0 docs/{ => developer}/drop-in-scripts.rst | 0 docs/{ => developer}/iscsi.rst | 0 docs/{ => developer}/mount-points.rst | 0 docs/{ => developer}/multipath.rst | 0 docs/{ => developer}/sysconfig-file.rst | 0 docs/{ => developer}/testing.rst | 4 ++-- docs/index.rst | 10 +--------- 11 files changed, 23 insertions(+), 11 deletions(-) create mode 100644 docs/developer.rst rename docs/{ => developer}/commit-log.rst (100%) rename docs/{ => developer}/configuration-files.rst (100%) rename docs/{ => developer}/driverdisc.rst (100%) rename docs/{ => developer}/drop-in-scripts.rst (100%) rename docs/{ => developer}/iscsi.rst (100%) rename docs/{ => developer}/mount-points.rst (100%) rename docs/{ => developer}/multipath.rst (100%) rename docs/{ => developer}/sysconfig-file.rst (100%) rename docs/{ => developer}/testing.rst (97%) diff --git a/docs/developer.rst b/docs/developer.rst new file mode 100644 index 00000000000..cd7173b0756 --- /dev/null +++ b/docs/developer.rst @@ -0,0 +1,20 @@ +Developer documentation +======================= + +Here are topics which are covering mostly advanced topics to help users to modify Anaconda and understand the code. + +Contents: + +.. toctree:: + :maxdepth: 1 + + developer/commit-log + developer/configuration-files + developer/driverdisc + developer/iscsi + developer/mount-points + developer/multipath + developer/sysconfig-file + developer/drop-in-scripts + Testing + diff --git a/docs/commit-log.rst b/docs/developer/commit-log.rst similarity index 100% rename from docs/commit-log.rst rename to docs/developer/commit-log.rst diff --git a/docs/configuration-files.rst b/docs/developer/configuration-files.rst similarity index 100% rename from docs/configuration-files.rst rename to docs/developer/configuration-files.rst diff --git a/docs/driverdisc.rst b/docs/developer/driverdisc.rst similarity index 100% rename from docs/driverdisc.rst rename to docs/developer/driverdisc.rst diff --git a/docs/drop-in-scripts.rst b/docs/developer/drop-in-scripts.rst similarity index 100% rename from docs/drop-in-scripts.rst rename to docs/developer/drop-in-scripts.rst diff --git a/docs/iscsi.rst b/docs/developer/iscsi.rst similarity index 100% rename from docs/iscsi.rst rename to docs/developer/iscsi.rst diff --git a/docs/mount-points.rst b/docs/developer/mount-points.rst similarity index 100% rename from docs/mount-points.rst rename to docs/developer/mount-points.rst diff --git a/docs/multipath.rst b/docs/developer/multipath.rst similarity index 100% rename from docs/multipath.rst rename to docs/developer/multipath.rst diff --git a/docs/sysconfig-file.rst b/docs/developer/sysconfig-file.rst similarity index 100% rename from docs/sysconfig-file.rst rename to docs/developer/sysconfig-file.rst diff --git a/docs/testing.rst b/docs/developer/testing.rst similarity index 97% rename from docs/testing.rst rename to docs/developer/testing.rst index 9e92fce8586..76535f54e60 100644 --- a/docs/testing.rst +++ b/docs/developer/testing.rst @@ -1,5 +1,5 @@ -.. include:: ../tests/README.rst +.. include:: ../../tests/README.rst What to do if there are broken Rawhide dependencies =================================================== @@ -38,7 +38,7 @@ Cleanup old repository. $ ssh :fedorapeople.org $ cd /project/anaconda/repos/anaconda_fixup_repo/ $ rm -rv * # to remove the old directory structure - + Create your repository locally and upload that. :: diff --git a/docs/index.rst b/docs/index.rst index 7df4cd0e01c..05f620fd3e0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -15,18 +15,10 @@ Contents: release-notes boot-options kickstart - configuration-files How to report a bug common-bugs How to contribute - commit-log release - driverdisc - iscsi - multipath list-harddrives - drop-in-scripts - sysconfig-file - mount-points - Testing + developer ci-status From 87da24f432b1a93aab85d34c39ed07b6dd9e36d9 Mon Sep 17 00:00:00 2001 From: Jiri Konecny Date: Fri, 20 Dec 2024 13:10:36 +0100 Subject: [PATCH 4/4] Remove sections from release.rst in TOC The release.rst documentation used top level section for sub-sections. That resulted that these were visible in the main table of content which was confusing. --- docs/release.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/release.rst b/docs/release.rst index c5547646609..c4c5972ea5e 100644 --- a/docs/release.rst +++ b/docs/release.rst @@ -180,7 +180,7 @@ environment way see mock path below. It is also fully manual. Upcoming Fedora release & package build -======================================== +---------------------------------------- Creating an anaconda release and build for an upcoming Fedora release is pretty similar to a Rawhide build with a few key differences: @@ -217,7 +217,7 @@ A link to the update should be returned and you should also start getting regula anything remotely interesting happens with the update. :) Releasing during a Fedora code freeze -===================================== +------------------------------------- There are two generally multi-week phases during which the upcoming Fedora release development a temporary code freeze: @@ -232,7 +232,7 @@ If there is a merged PR that has not been approved for a FE or release blocker, targeting the frozen Fedora. Branching for the next Fedora release -===================================== +------------------------------------- Anaconda uses separate branch for each Fedora release to make parallel Anaconda development for Rawhide and next Fedora release possible. The branch is named fedora-. @@ -244,7 +244,7 @@ and release blocker fixes. Create new localization directory for Anaconda ----------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ First thing which needs to be done before branching in Anaconda is to create a new localization directory which will be used by the new Anaconda branch. @@ -282,7 +282,7 @@ Push new localization directory. This will be automatically discovered and added Adjust localization update automation -------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In the ``anaconda-l10n`` repository, the update automation needs to work on the new directory. @@ -318,7 +318,7 @@ Push the changes: Enable Cockpit CI for the new branch -------------------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Anaconda is using the Cockpit CI infrastructure to run Web UI test. Cockpit CI tests are triggered automatically for all `listed `_ projects and per-project branches. To enable Cockpit CI in automatic mode for the new Fedora branch, our new fedora- upstream branch needs to be added under the 'rhinstaller/anaconda' key in the file. See the previous PR (for F39) to see how this is to be done: @@ -326,7 +326,7 @@ automatically for all `listed