Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc/rtd/howto/bugs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Bugs for upstream ``cloud-init`` are tracked using GitHub Issues. To file a
bug:

1. Collect the necessary debug logs as described above.
2. `Report an upstream cloud-init bug`_ on GitHub.
2. `Report an upstream cloud-init bug<open issues>` on GitHub.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Sorry for suggesting this earlier.

Turns out I don't think sphinx supports name reference link sharing as it does with document anchor :ref:s.

We'd either need to embed the link directly like so:

Suggested change
2. `Report an upstream cloud-init bug<open issues>` on GitHub.
2. `Report an upstream cloud-init bug <https://github.com/canonical/cloud-init/issues>` on GitHub.

or just use separate "named links" in LINKS: as we currently have in the file anyway.
Let's defer to use what we have and avoid inline representation of links. I prefer if we are all down in designated LINKS: section for readability.


Bug reports that lack complete logs may be labeled ``incomplete`` until
sufficient information is provided. To aid in debugging, please include the
Expand Down Expand Up @@ -123,7 +123,6 @@ details.

.. LINKS:
.. _open issues: https://github.com/canonical/cloud-init/issues
.. _Report an upstream cloud-init bug: https://github.com/canonical/cloud-init/issues
.. _Ubuntu bug tracker: https://bugs.launchpad.net/ubuntu/+source/cloud-init/+filebug
.. _Debian bug tracker: https://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=cloud-init;dist=unstable
.. _Debian bug reporting wiki: https://www.debian.org/Bugs/Reporting
Expand Down