dei/docs
dei/docs
7
1
Fork 1
Code Issues Pull requests 1 Activity Actions
docs/CONTRIBUTING.md

2.2 KiB
Raw Permalink Blame History

How to contribute to Fedora DEI Team documentation

Please report issues and submit pull requests for Content Fixes to Fedora DEI documentation here. General appearance issues and publishing issues should be reported against the publishing software.

Never done a pull request (or "PR")? See the GitHub Guides for getting started with git. If you already know git, see the GitLab documentation for Merge Requests on how to submit contributions on GitLab.

How to edit these documents

Content for the Fedora DEI Team documentation is stored in this repository. Source content is written in AsciiDoc. See these resources for help using AsciiDoc:

Test with a local preview

This repo includes scripts to build and preview the contents of this repository.

NOTE: If you use a xref to link to pages in other repositories, those links will not work in the local preview, as it only builds this repository. If you want to rebuild the whole Fedora Docs site, see the Fedora Docs build repository for more instructions.

Both of the below scripts use containers, so ensure either Podman or Docker is installed on your system before beginning. To build and preview the site, open a command prompt or terminal and execute this command:

./build.sh && ./preview.sh

The local preview is visible at http://localhost:8080.