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

Add instructions for GitLab Pages #1287

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

hansfn
Copy link

@hansfn hansfn commented Aug 5, 2024

@hansfn
Copy link
Author

hansfn commented Aug 5, 2024

Simple POC.

@mcanouil
Copy link
Contributor

mcanouil commented Aug 5, 2024

I am not sure we want to document the use of third party Docker images that did not receive any update (or Docker build) for almost two years now.

I would at least use the Docker images built by Quarto: https://github.com/orgs/quarto-dev/packages?repo_name=quarto-cli

EDIT: also, the "forge" does not keep versions.

@hansfn
Copy link
Author

hansfn commented Aug 5, 2024

Sure, I can update the PR (later today) to use the official Docker images. I wasn't really sure about the status for "Quarto Forge".

Any other things that you think should be updated / improved?

Added: It seems the Forge Docker images are stuck on 1.4 and "Published 7 months ago":

$ docker run registry.gitlab.com/quarto-forge/docker/quarto quarto --version
1.4.521

The images from Quarto Forge are not well-maintained.
@hansfn
Copy link
Author

hansfn commented Aug 6, 2024

Just for the record: The PR is updated / corrected - ref commits.

Copy link
Collaborator

@cderv cderv left a comment

Choose a reason for hiding this comment

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

Thanks for the suggestion.

We are at the limit of how we want to document things here. Quarto documentation aims to details what is directly supported by quarto publish.

Gitlab pages is not among this. This means it could be part of Other Services we document.

So I would be incline to move it here so that it is not confusing. Maybe we'll do a quarto publish gitlab-pages one day.

@@ -4,6 +4,7 @@
|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Quarto Pub](/docs/publishing/quarto-pub.qmd) | Publishing service for Quarto documents, websites, and books. Use Quarto Pub when you want a free, easy to use service for publicly available content. |
| [GitHub Pages](/docs/publishing/github-pages.qmd) | Publish content based on source code managed within a GitHub repository. Use GitHub Pages when the source code for your document or site is hosted on GitHub. |
| [GitLab Pages](/docs/publishing/gitlab-pages.qmd) | Publish content based on source code managed within a GitLab repository. Use GitLab Pages when the source code for your document or site is hosted on GitLab. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

This tables is currently only listing what is available through quarto publish. Any other provider is supposed to be mentioned in Other services.

It could be confusing to put Gitlab pages at first level, as it is not directly supported in quarto publish gitlab-pages


There s currently only one way to publish Quarto websites and documents to GitLab Pages:

1. Use a [GitLab Pipeline] to automatically render your files (a single Quarto document or a Quarto project) and publish the resulting content whenever you push a source code change to your repository.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this missing an external link or aim is to reference the section below ?

For the later case, I think we should make the link explicit using an explicit id.

Copy link
Author

@hansfn hansfn Aug 26, 2024

Choose a reason for hiding this comment

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

I'm just using the same trick (?) that is used in github-pages.qmd: A link with no target pointing to an anchor for a heading on the same page.

@hansfn
Copy link
Author

hansfn commented Aug 26, 2024

We are at the limit of how we want to document things here. Quarto documentation aims to details what is directly supported by quarto publish.

Valid point. I had not fully understood the structure of the documentation. I'll clean up my PR. (Yes, quarto publish gitlab-pages should IMO exist.)

@hansfn
Copy link
Author

hansfn commented Aug 26, 2024

I have updated the PR.

PS! I can remove "GitLab Pages" form other.qmd (revert the changes) too if you think it's just noise. I'm happy as long as GitLab is listed on ci.qmd.

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.

Gitlab: Create Static Sites
3 participants