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

Build and host documentation on this repository's GH Pages #27

Open
pniedzielski opened this issue Feb 7, 2024 · 1 comment
Open

Build and host documentation on this repository's GH Pages #27

pniedzielski opened this issue Feb 7, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers skip news No news entry is required

Comments

@pniedzielski
Copy link
Collaborator

We cannot automatically build and host this package's documentation on release, because the documentation is currently hosted on the main bloomberg/blazingmq repository. This means that every time we update the documentation for this package, we have to manually file a PR against that repository, have it reviewed, and have it merged into the main repo. The process would be much simpler if we instead build and deploy the documentation within our GitHub Actions workflow on each release, publishing to our own repo's GitHub pages.

@pniedzielski pniedzielski added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers skip news No news entry is required labels Feb 7, 2024
@pniedzielski pniedzielski self-assigned this Feb 7, 2024
@pniedzielski
Copy link
Collaborator Author

To do this, we will need to enable GitHub pages for this repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers skip news No news entry is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant