Skip to content
Open
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions docs/publish-your-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,3 +109,10 @@ Your documentation is now published under `<username>.gitlab.io/<repository>`.
[site_dir]: setup/basics.md#site_dir
[default branch]: https://docs.gitlab.com/ee/user/project/repository/branches/default.html

## Other

We cannot document every hosting provider here. The following community guides
describe how to deploy a Zensical site elsewhere:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would like this to be more explicit, stating that we do not maintain these guides and that if people find issues they should contact the respective maintainers. How about:

"...site elsewhere. If you find an issue with one of these guides, please contact the author."

This loses the colon just before the list but I think that is ok.


* [Azure Static Web Apps with GitHub](https://zensical-guides.hypercat.net/azure-static-web-app-github/)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should this be "GitHub Actions", so it is clear what the "GitHub" part does here?

* [Azure Static Web Apps with Azure DevOps](https://zensical-guides.hypercat.net/azure-static-web-app-devops/)
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Would it help us to have links to the issue tracker here - or should there be a link in the guide itself? I know the repository is linked in the header but a note on reporting issues in the right place might still be a good idea.

We could make a policy decision that we only link to guides that clearly indicate where issues should be reported. This may seem like a relatively minor issue but I think we save ourselves a lot of trouble if we are as clear about it as possible.