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

Documentation preview in pull requests #49

Open
kolyshkin opened this issue Oct 5, 2020 · 3 comments
Open

Documentation preview in pull requests #49

kolyshkin opened this issue Oct 5, 2020 · 3 comments
Labels
help wanted Extra attention is needed

Comments

@kolyshkin
Copy link
Collaborator

Some github repos have mechanisms to show documentation preview in PRs, so that if any documentation is changed, a reviewer can see how it looks like. One such example is https://github.com/docker/docker.github.io (see e.g. docker/docs/pull/11476), implemented via netlify.

We need something like this, too.

Cc @thaJeztah

@thaJeztah
Copy link
Member

Not sure if something like that exists for godoc. We could of course run godoc ourselves, and save it somewhere, idk

@kolyshkin
Copy link
Collaborator Author

We can use Github actions and publish artifacts. Let me see...

@kolyshkin
Copy link
Collaborator Author

Made an attempt but failed: #63

We need something like netlify for this, github actions is not adequate.

@kolyshkin kolyshkin added the help wanted Extra attention is needed label Feb 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants