Shorten README
I've shortened this README based on what we came up with in this issue: docs/tickets#36
This commit is contained in:
parent
ee2b26ddb2
commit
39a73b149d
1 changed files with 21 additions and 8 deletions
29
README.md
29
README.md
|
|
@ -1,16 +1,29 @@
|
|||
# Fedora User Documentation Home
|
||||
|
||||
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.
|
||||
The Fedora User Documentation subpage on the docs front page. Also pulls in the Release Notes.
|
||||
|
||||
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).
|
||||
## Published documentation
|
||||
|
||||
## How to edit these documents
|
||||
The published version of this documentation is available at:
|
||||
[https://docs.fedoraproject.org/en-US/fedora/latest/](https://docs.fedoraproject.org/en-US/fedora/latest/)
|
||||
|
||||
All of this is written in AsciiDoc. It’s a simple mostly-plain-text
|
||||
markup language. You may want to look at:
|
||||
## Contributing
|
||||
|
||||
We welcome contributions! Whether it's fixing a typo, reporting an outdated
|
||||
page, or writing new content — every little bit helps.
|
||||
|
||||
* [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
|
||||
* [AsciiDoc Writer’s Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/)
|
||||
* [Antora Documentation](https://docs.antora.org/antora/1.0/page/)
|
||||
> **Note:** This is a versioned repository — there is a separate branch for each
|
||||
> Fedora release. Pull requests should generally go to these release-specific branches.
|
||||
> Branch `main` is only used as a template from which each new version is branched.
|
||||
|
||||
See the [Fedora Docs Contributor Guide](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/)
|
||||
for how to get started.
|
||||
|
||||
Please report **content issues** in this repository.
|
||||
For general site/publishing issues, use the
|
||||
[Fedora Docs Website repository](https://forge.fedoraproject.org/docs/docs-fp-o).
|
||||
|
||||
## Contact
|
||||
- **Matrix:** [#docs:fedoraproject.org](https://matrix.to/#/#docs:fedoraproject.org)
|
||||
- **Private comms:** Use our FAS emails for anything that shouldn't be public.
|
||||
- **Discussion forums:** [discussion.fedoraproject.org](https://discussion.fedoraproject.org/tag/docs-team/337)
|
||||
Loading…
Add table
Add a link
Reference in a new issue