Pages: Repositories currently have to be public (#395)

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/395
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
This commit is contained in:
Panagiotis "Ivory" Vasilopoulos 2024-03-10 16:13:45 +00:00
parent d852c5ac0d
commit 2ce0c26e3d
2 changed files with 7 additions and 1 deletions

View file

@ -10,7 +10,7 @@ Codeberg Pages allows you to easily publish static websites with a human-friendl
Follow these simple steps below to get started, or check out the advanced usage below. Follow these simple steps below to get started, or check out the advanced usage below.
1. Create a public repository named 'pages' in your user account or organization. 1. Create a **public** repository named 'pages' in your user account or organization.
2. Create static content, HTML, stylesheets, fonts or images. Name the homepage file `index.html`. 2. Create static content, HTML, stylesheets, fonts or images. Name the homepage file `index.html`.
3. Push your content to the default branch of the new repository. 3. Push your content to the default branch of the new repository.
4. You should now be able to access your content by visiting `{username}.codeberg.page`. 4. You should now be able to access your content by visiting `{username}.codeberg.page`.

View file

@ -16,6 +16,12 @@ To begin with, we will have two separate repositories, both locally and on Codeb
- A second repository for Codeberg pages that we will call the `pages` repository. This repository will only contain the files available in the `html` folder located under docs/build/html. - A second repository for Codeberg pages that we will call the `pages` repository. This repository will only contain the files available in the `html` folder located under docs/build/html.
{% admonition "warning" %}
The `pages` repository **must** be public, as Codeberg Pages will directly fetch the files from the repository, just like an ordinary user would.
{% endadmonition %}
{% admonition "info" %} {% admonition "info" %}
For the purpose of this guide, we have chosen to use two separate folders/repositories. However, you may want to have a different setup that involves creating a [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) instead of having folders and repositories in separate locations. With a submodule, your configuration may look like so: For the purpose of this guide, we have chosen to use two separate folders/repositories. However, you may want to have a different setup that involves creating a [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) instead of having folders and repositories in separate locations. With a submodule, your configuration may look like so: