pbokoc/team-docs
1
0
Fork 0
forked from docs/team-docs
Code Pull requests Activity

forge-web

Browse source
This commit is contained in:
Eli Ridge 2026-04-11 14:01:47 +12:00
commit dd6c44eee3
2 changed files with 55 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

4
modules/ROOT/nav.adoc
View file

@ -18,7 +18,9 @@
*** xref:contributing-docs/tools-file-edit-pagure.adoc[How to edit files on the Pagure Web UI]
*** xref:contributing-docs/tools-local-authoring-env.adoc[How to create and use a local Fedora authoring environment]
*** xref:contributing-docs/tools-localenv-preview.adoc[How to run a local preview]
*** xref:contributing-docs/tools-vale-linter.adoc[How to check documentation style with Vale]
*** xref:contributing-docs/tools-vale-linter.adoc[How to check documentation style with Vale]
*** xref:contributing-docs/tools-file-edit-forge.adoc[Edit a single page in Forge]
** xref:contributing-docs/style-guide.adoc[The docs style guide]
** xref:contributing-docs/asciidoc-intro.adoc[AsciiDoc for Fedora]

52
modules/ROOT/pages/contributing-docs/tools-file-edit-forge.adoc Normal file
View file

@ -0,0 +1,52 @@
= Edit a Page Using the Forge Web Interface
Eli R
:revnumber: F43 and newer
:revdate: 2026-04-04
This section will guide you through editing a documentation (docs) page using the Fedora Forge web interface.
Use this method for small changes, such as fixing typos or other simple edits that affect a single page.
== Preparation
* Complete the contributor https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/#_prerequisites[*prerequisites*].
== Edit via the Forge web interface
Every documentation page has an icon:edit[] *Edit this page* button.
Use this to locate the page's source repository on Fedora Forge.
Starting from the docs.fedoraproject.org page that you intend to edit:
1. Click the icon:edit[] *Edit* button to navigate to the source page.
2. If you are not already signed in, do so with your FAS account.
3. Click the *Fork* button (normally top right). If prompted, enter the details to create your new fork. The default values are suitable in most cases.
+
IMPORTANT: If you receive a warning that the branch is behind in commits, click the _Sync_ button so that it matches the upstream repo.
4. Manually navigate the folder structure to return to the source page you intend to edit (normally in modules/ROOT/pages/).
5. Click the icon:pen[] *Edit* button, and make your changes directly to the AsciiDoc code.
6. Use the icon:eye[] *Preview* button to see how the document will look. Keep in mind that some AsciiDoc elements may not render accurately in the preview.
7. Once you are happy with the edit, scroll to the bottom of the page, and optionally add a message describing the nature of the edit.
8. Check "Create a *new branch* for this commit and start a pull request". Optionally, rename the new branch.
9. Click *propose file change*, which brings you to the *New pull request* page
10. Use the first drop-down selector, *merge into*, to select the upstream repo. This is normally the *main* branch, but check with the repository maintainers if in doubt.
11. Ensure the *pull from* selector is set to your personal fork, on the newly created branch from step 8.
12. Click *New pull request*.
13. Carry out any final checks, then click *Create pull request*.
[NOTE]
====
It may take a number of days before your pull request is reviewed. If you have not received a response within five days of opening the PR, consider using Matrix to reach out to the team that is responsible for that repo.
====