961654 - Landfill bugzilla-tip links are broken in new reST docs

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[GavinS]

The `<|landfillbase|>`_. is not substituted correctly (at all) in Chapter 5, "Using Bugzilla".

Something to do with the surrounding backticks preventing substitution maybe?

Comment 1

[Gervase Markham [:gerv]]

Yes; reST doesn't support nested inline markup. I will fix.

Gerv

Comment 2

[Gervase Markham [:gerv]]

Attachment: Patch v.1

Given that we are linking directly to the tip, that URL is stable, so the best fix is just to insert the URL directly. I've also tidied up the links so they all have link text, and removed an unused definition (bzg-bugs) from definitions.rst.tmpl.

Gerv

Comment 3

[Frédéric Buclin]

Comment on attachment 8363650 [details] [diff] [review]
Patch v.1

>=== modified file 'docs/en/rst/using.rst'

>+`Landfill <http://landfill.bugzilla.org/bugzilla-tip/>`_.
>+`Landfill <http://landfill.bugzilla.org/bugzilla-tip/query.cgi>`_.
>+      `Landfill <http://landfill.bugzilla.org/bugzilla-tip/>`_.

Sphinx doesn't like that you use 3 times the same name for different URLs:

  bugzilla/docs/en/rst/using.rst:7: WARNING: Duplicate explicit target name: "landfill".

Either you must use anonymous references (two underscores, not ideal), or you must use different names, see e.g. http://stackoverflow.com/questions/5464627/how-to-have-same-text-in-two-links-with-restructured-text

Comment 4

[Gervase Markham [:gerv]]

Attachment: Patch v.2

This compiles for me with no errors.

Gerv

Comment 5

[Frédéric Buclin]

Comment on attachment 8365298 [details] [diff] [review]
Patch v.2

>=== modified file 'docs/en/rst/using.rst'

>+Landfill <http://landfill.bugzilla.org/bugzilla-tip/query.cgi>`_.

By default, the simple search form is displayed, and so fields this text is referring to are not visible. You should append ?format=advanced to the URL to display the advanced search form.

r=LpSolit with this fix on checkin.

Comment 6

[Gervase Markham [:gerv]]

Committing  to: bzr+ssh://bzr.mozilla.org/bugzilla/trunk/                        
modified docs/en/rst/using.rst
modified docs/definitions.rst.tmpl
modified docs/en/rst/customization.rst

Committed revision 8892.

Gerv