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.

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

Conversation

niclasheinz
Copy link
Collaborator

@niclasheinz niclasheinz commented Dec 29, 2024

I have noticed that since a few GitLab releases, unique domains are used by default for GitLab Pages deployments, for example https://website-5c034c.gitlab.io/ instead of niclasheinz.gitlab.io/website. I have written a small blog post that helps users to use the desired domain.

@squidfunk
Copy link
Owner

Thanks for the PR. Is this also true for GitLab's hosted offering, or only for on-premise installations?

@niclasheinz
Copy link
Collaborator Author

niclasheinz commented Dec 30, 2024

I discouvered it on gitlab.com (SaaS)

@squidfunk
Copy link
Owner

Thanks! So if it's such a central thing, I think it would be a better idea to list the steps that you listed in your blog post directly on our publishing guide, so we can keep the AX better – less indirection. If and only if this is okay for you.

@niclasheinz
Copy link
Collaborator Author

Yes, sure! I just did this so that the site doesn't get too crowded with information. Should I make an extra page or is it enough if I just write it down under the CI codeblock?

@squidfunk
Copy link
Owner

squidfunk commented Dec 30, 2024

Just under the code block is fine. I think we can limit it to something like (extracted from your article):

CODE BLOCK

${Insert 1 sentence explanation on domain names}. 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 Use unique domain.
4. Click Save changes to apply the update.

Now, you ...

And we should link to the release notes, as you did in your article.

@niclasheinz
Copy link
Collaborator Author

Should I use such a box to keep the content clearer?

Screenshot_20241230_133850

@squidfunk
Copy link
Owner

No, please just use verbatim text. It's not a recommendation, but the expected outcome (= users will 99% want a proper URL, and not a random identifier), so it should be part of the normal flow.

@niclasheinz
Copy link
Collaborator Author

@squidfunk it's ready for review.

Copy link
Owner

@squidfunk squidfunk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only some minor changes related to formatting ☺️

docs/publishing-your-site.md Outdated Show resolved Hide resolved
docs/publishing-your-site.md Outdated Show resolved Hide resolved
docs/publishing-your-site.md Outdated Show resolved Hide resolved
docs/publishing-your-site.md Show resolved Hide resolved
@niclasheinz
Copy link
Collaborator Author

I solved the styling issues

@squidfunk
Copy link
Owner

Perfect, thanks for your work!

@squidfunk squidfunk merged commit 307fceb into squidfunk:master Dec 31, 2024
4 checks passed
@niclasheinz
Copy link
Collaborator Author

You're welcome. Happy new year!

@niclasheinz niclasheinz deleted the gitlab-docs-patch branch December 31, 2024 08:49
@squidfunk
Copy link
Owner

Happy new year to you too!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants