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

dev: use to GitHub Pages #3884

Merged
merged 2 commits into from
Jun 5, 2023
Merged

dev: use to GitHub Pages #3884

merged 2 commits into from
Jun 5, 2023

Conversation

ldez
Copy link
Member

@ldez ldez commented Jun 3, 2023

Currently, only one person has access to the Netlify administration (it's not me) and this is a problem because it can be really difficult when we have to update something inside the Netlify admin.

It will be easier to diagnose and fix problems like #3663.

This PR introduces Github Pages in parallel with Netlify because we need to have the branch and the content before setting up the custom domain.

When we will set the custom domain, I will open another PR to remove Netlify-related files.

FYI: I tested this PR on my fork.

@ldez ldez added enhancement New feature or improvement area: docs labels Jun 3, 2023
@ldez ldez force-pushed the feat/docs-ghpages branch from 787fe4e to de3c5aa Compare June 4, 2023 14:32
Comment on lines +3 to +6
on:
push:
branches:
- master
Copy link
Member

Choose a reason for hiding this comment

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

If this will be an alternative official documentation, should this rather be when tagging and not pushing to master?

Copy link
Member Author

@ldez ldez Jun 5, 2023

Choose a reason for hiding this comment

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

currently, we publish the doc every time a change happens on the doc.
It's a requirement to be able to apply a fix on the documentation.

Copy link
Member

Choose a reason for hiding this comment

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

Makes sense! Would be nice if we could clarify that. It will f.ex. also add docs for new linters not yet released.

Copy link
Member Author

@ldez ldez Jun 5, 2023

Choose a reason for hiding this comment

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

It's already the case, I added Since in the documentation there is a long time ago (2021) in #1854.

https://golangci-lint.run/usage/linters/

Copy link
Member

Choose a reason for hiding this comment

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

Yeah I know but that requires people to actually read the docs and figure out what the current version is :)

It was also just an example but let’s see if it becomes a problem and not try to solve anything until then!

.github/workflows/documentation.yml Outdated Show resolved Hide resolved
@ldez ldez merged commit d6cd051 into golangci:master Jun 5, 2023
@ldez ldez deleted the feat/docs-ghpages branch June 5, 2023 21:03
@ldez ldez mentioned this pull request Jun 6, 2023
4 tasks
@ldez ldez mentioned this pull request Aug 17, 2023
@ldez ldez added this to the v1.53 milestone Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs enhancement New feature or improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants