Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(publish gitlab pages): Update publish comment on gitlab #7853

Merged
merged 3 commits into from
Dec 31, 2024
Merged

docs(publish gitlab pages): Update publish comment on gitlab #7853

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e23c973
docs(publish gitlab pages): Update publish comment on gitlab
niclasheinz Dec 29, 2024
748891e
docs(publish gitlab): Add guide how to disable unique domains
niclasheinz Dec 30, 2024
d08bd6f
docs(publish gitlab pages): Solve some styling issues
niclasheinz Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion docs/publishing-your-site.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,23 @@ Now, when a new commit is pushed to the [default branch] (typically `master` or
`main`), the static site is automatically built and deployed. Commit and push
the file to your repository to see the workflow in action.

Your documentation should shortly appear at `<username>.gitlab.io/<repository>`.
Your documentation is not published under `<username>.gitlab.io/<repository>`
by default since **GitLab 17.4** [^1]. However, if you prefer a cleaner URL
structure, such as `<username>.gitlab.io/<repository>`, you need to adjust
your configuration.

To switch from a unique domain to the traditional URL structure, follow
these steps:

1. Locate Your Repository
2. Go to **Settings › Pages** in the repository menu.
3. In the **Unique domain settings** section, **uncheck** the box labeled
4. **Use unique domain**.
5. Click **Save changes** to apply the update.

Now you can reach your documentation under `<username>.gitlab.io/<repository>`.

[^1]: [Release notes for Gitlab 17.4](https://about.gitlab.com/releases/2024/09/19/gitlab-17-4-released/)
niclasheinz marked this conversation as resolved.
Show resolved Hide resolved

## Other

Expand Down
Loading