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

Auto Update Docs #14

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Auto Update Docs #14

wants to merge 1 commit into from

Conversation

confused-Techie
Copy link
Member

Relates to #13

This PR brings in a GitHub Action to auto update the source code documentation in the same manner we update pulsar-edit/pulsar-chocolatey.

That is:

  • Create an issue with the title just containing the new Pulsar version.
  • Once posted add a special issue label, in this case update-docs
  • Afterwards a PR will be generated containing the changes that can be reviewed.

This behavior will not occur automatically. But will enable us to start generating documentation easily for any newest version of Pulsar.
Ideally, the creation of the initial issue will be further handled by our new release automation.

@confused-Techie
Copy link
Member Author

An edit, I've now created the associated label update-docs on this repository, and added the capabilities of this PR to be triggered via our release automation.

@confused-Techie confused-Techie linked an issue Dec 30, 2024 that may be closed by this pull request
1 task
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.

Automatic generation of API docs
1 participant