hank-test/quick-docs
1
0
Fork 0
mirror of https://pagure.io/fedora-docs/quick-docs.git synced 2024-11-24 21:35:17 +00:00
Code Issues 1 Projects Releases Packages Wiki Activity Actions
Migration test of Quick Docs
814 commits 1 branch 0 tags 9.9 MiB
Shell 100%
Find a file
Ben Cotton 17b90c2e01 Update "additional resources" links for AIDE 
Fixes #387
2022-05-05 14:55:10 -04:00
modules/ROOT Update "additional resources" links for AIDE 2022-05-05 14:55:10 -04:00
.gitignore switch to Antora part 2018-07-27 18:53:34 +02:00
antora.yml *.yaml: Minor styling fixes 2022-02-08 18:36:49 +01:00
build.sh build: Update with latest version from template 2022-03-03 10:23:37 +01:00
LICENSE Add LICENSE 2019-09-17 14:29:46 +02:00
preview.sh Quote command substitution which may have spaces 2020-07-28 18:01:38 +00:00
README.md Fix incorrect apostrophe in README.md 2021-04-28 15:45:47 +00:00
site.yml feat: use new URL for UI bundle 2022-04-13 12:25:13 +01:00

README.md

Fedora Quick Docs

This is the content repository for the Fedora Quick Docs.

Please report Issues and submit Pull Requests for Content Fixes here. Never done a pull request (or "PR")? Here's the Pagure documentation for Pull Requests.

General appearance issues and publishing issues should be reported against the publishing software.

Reviewers needed!

As discussed in issue #107, a lot of pages in this repository are in need of a technical review. Pages which need one are marked by a disclaimer on the top of the file, right below the top level heading. Any reviews are greatly appreciated. If you want to help, pick one of the pages, check it for accuracy, and then:

  • If you find that all information on the page is correct, either open a pull request which states that you found no problems and which removes the disclaimer from the top (the include::) statement at the top, or open an issue against this repository stating which page you reviewed and found no errors in so we can remove it
  • If you find errors, then either open a pull request fixing them and removing the disclaimer from the top, or open an issue and describe the errors you found, and how to fix them if you know a fix

How to edit these documents

All of this is written in AsciiDoc. It's a simple mostly-plain-text markup language. You may want to look at:

Local preview

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

NOTE: Please note that if you reference pages from other repositories, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see the Fedora Docs build repository for instructions.

Both scripts use podman in F30 and above. Please make sure you have podman installed on your system (you can also use Docker, but on Fedora podman is recommended).

Installing podman on Fedora

$ sudo dnf install podman

To build and preview the site, run:

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

The result will be available at http://localhost:8080