search

canonical / sphinx-docs-starter-pack

A documentation starter-pack
https://canonical-starter-pack.readthedocs-hosted.com/
Other
15 stars 37 forks source link

Automatic Jira issue creation #132

Closed jugmac00 closed 8 months ago

jugmac00 commented 11 months ago

After creating an issue in my project, using this starter pack, automatically an issue in the Jira board for the sphinx-starter-kit was created.

Currently, on the readme, it says it is all optional, so I did not have a closer look, but actually, it is configured by default, and you need to actively remove the sync.

This should be mentioned in the https://github.com/canonical/sphinx-docs-starter-pack#configure-the-documentation section.

syncronize-issues-to-jira[bot] commented 11 months ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/DOCPR-181.

This message was autogenerated

ru-fu commented 11 months ago

We have now removed the sync to prevent this issue (thanks @keirthana !). We'll discuss whether and how we can bring it back without accidentally enabling it on all repos that have the file.

Thanks for reporting!

ru-fu commented 8 months ago

We'll leave this out - it's not related to documentation, so there's no need to have it in the starter pack, and if we were to include it we'd need to have a lot of workarounds to prevent it from working for others.