docs/release-notes
19
0
Fork 7
Code Issues 41 Pull requests Projects Activity Actions

Update README for Gitlab move

Browse source 
Signed-off-by: Adam Williamson <awilliam@redhat.com>
This commit is contained in:
Adam Williamson 2024-03-27 09:02:47 -07:00
commit 2310942f0f
1 changed files with 14 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,12 +1,12 @@
# Fedora Release Notes
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).
Never done a pull request (or "PR")? Here's the [Gitlab documentation for
Pull Requests](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html).
General appearance issues and publishing issues should be reported against
the [publishing software](https://pagure.io/fedora-docs/docs-fp-o).
the [publishing software](https://gitlab.com/fedora/docs/docs-website/docs-fp-o).
## Structure
@ -51,7 +51,7 @@ Antora introduces two new terms:
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.
**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://gitlab.com/fedora/docs/docs-website/docs-fp-o) for instructions.
Both scripts work on Fedora (using Podman) and macOS (using Docker).
@ -76,14 +76,15 @@ $ sudo dnf install podman
You can also build the whole Fedora Docs site locally to see your changes in the whole context.
This is especially useful for checking if your `xref` links work properly.
To do this, you need to clone the main [Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o), modify the `site.yml` file to reference a repo with your changes, and build it.
To do this, you need to clone the main [Fedora Docs build repository](https://gitlab.com/fedora/docs/docs-website/docs-fp-o), modify the `site.yml` file to reference a repo with your changes, and build it.
Steps:
Clone the main repository and cd into it:
Clone the main repository and cd into it, then checkout the `prod` branch:
```
$ git clone https://pagure.io/fedora-docs/docs-fp-o.git
$ git clone https://gitlab.com/fedora/docs/docs-website/docs-fp-o.git
$ cd docs-fp-o
$ git checkout prod
```
Find a reference to the repository you're changing in the `site.yml` file, and change it so it points to your change.
@ -91,18 +92,18 @@ So for example, if I made a modification to the Modularity docs, I would find:
```
...
- url: https://pagure.io/fedora-docs/modularity.git
branches:
- master
- url: https://gitlab.com/fedora/docs/fedora-linux-documentation/release-notes.git
branches:
- master
...
```
And replaced it with a pointer to my fork:
```
...
- url: https://pagure.io/forks/asamalik/fedora-docs/modularity.git
branches:
- master
- url: https://gitlab.com/AdamWill/release-notes.git
branches:
- master
...
```