docs/release-docs-home
20
1
Fork 3
Code Issues 1 Pull requests Projects Activity Actions

Remove pagure, add GitLab, make the readme.md generic

Browse source
This commit is contained in:
Chris 2022-09-21 13:39:31 +00:00
commit 98d3c27139
1 changed files with 2 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -1,12 +1,8 @@
# Fedora User Documentation Home
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](https://docs.pagure.org/pagure/usage/pull_requests.html).
You can report Issues and submit Merge Requests for **Content Fixes** here. However, this repo is usually maintained internally. If you are unsure what to do, open a ticket.
General appearance issues and publishing issues should be reported against
the [publishing software](https://pagure.io/fedora-docs/docs-fp-o).
General appearance issues and publishing issues should be reported against [/ fedora / Fedora Docs / Docs Website / Fedora Docs pages](https://gitlab.com/fedora/docs/docs-website/pages).
## How to edit these documents
@ -18,26 +14,3 @@ markup language. You may want to look at:
* [AsciiDoc Writer’s Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/)
* [Antora Documentation](https://docs.antora.org/antora/1.0/page/)
## 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 repositoreis, 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](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.
Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions.
To build and preview the site, run:
```
$ ./build.sh && ./preview.sh
```
The result will be available at http://localhost:8080
### Installing docker on Fedora
```
$ sudo dnf install docker
$ sudo systemctl start docker && sudo systemctl enable docker
```