Update README.md
- Fixed Markdown - Updated build and preview instructions - Updated links Signed-off-by: Sandro Bonazzola <sbonazzo@redhat.com>
This commit is contained in:
parent
357f19f81b
commit
529c5bacf0
1 changed files with 4 additions and 7 deletions
11
README.md
11
README.md
|
|
@ -1,11 +1,9 @@
|
|||
Fedora Mindshare Committee documentation
|
||||
========================================
|
||||
# Fedora Mindshare Committee documentation
|
||||
|
||||
This repository contains the source content for the [Fedora Mindshare Committee documentation][1].
|
||||
The Antora configuration files and AsciiDoc source content are hosted in this repository.
|
||||
Please report Issues and submit Merge Requests for **content fixes** here.
|
||||
|
||||
|
||||
## Report an issue with the Mindshare Committee docs
|
||||
|
||||
Noticed some wrong or incorrect with the Mindshare Committee documentation?
|
||||
|
|
@ -14,7 +12,6 @@ Check the list of open issues first to see if someone else has already reported
|
|||
|
||||
[**Fedora Mindshare Committee docs issues**][2]
|
||||
|
||||
|
||||
## Local preview
|
||||
|
||||
This repo includes scripts to build and preview the contents of this repository.
|
||||
|
|
@ -23,7 +20,7 @@ To build and preview the site, run the following commands in a terminal:
|
|||
|
||||
```sh
|
||||
cd /path/to/fedora/mindshare/docs/
|
||||
./build.sh && ./preview.sh
|
||||
./docsbuilder.sh -b && ./docsbuilder.sh -p
|
||||
```
|
||||
|
||||
A preview of local changes will be available at [localhost:8080](http://localhost:8080).
|
||||
|
|
@ -40,5 +37,5 @@ sudo dnf install podman
|
|||
```
|
||||
|
||||
[1]: https://docs.fedoraproject.org/en-US/mindshare-committee/
|
||||
[2]: https://gitlab.com/fedora/mindshare/docs/-/issues
|
||||
[3]: https://gitlab.com/fedora/docs/docs-website/docs-fp-o
|
||||
[2]: https://forge.fedoraproject.org/mindshare/docs/issues
|
||||
[3]: https://forge.fedoraproject.org/docs/docs-fp-o
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue