The snap parts wiki is ugly. Add code markers around the wiki and add support in the parser.

Bug #1592133 reported by Joe Talbott
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Snapcraft
Fix Released
Medium
Joe Talbott
snapcraft (Ubuntu)
Fix Released
Undecided
Unassigned
Xenial
Fix Released
Medium
Unassigned
Yakkety
Fix Released
Medium
Unassigned

Bug Description

Add "```" around the wiki data and add support in the parser.

[Impact]

 * The wiki is hard to read.

[Test Case]

 * Add the marker tags to the wiki, run snapcraft-parser and check that they are ignored in the output.

[Regression Potential]

 * snapcraft-parse is relatively new. Some other use cases could be affected, so extensive exploratory is required here.

Joe Talbott (joetalbott)
Changed in snapcraft:
assignee: nobody → Joe Talbott (joetalbott)
status: New → In Progress
Revision history for this message
Joe Talbott (joetalbott) wrote :

It should be "{{{" and "}}}" not "```".

Changed in snapcraft:
status: In Progress → Fix Committed
milestone: none → 2.12
importance: Undecided → Medium
Revision history for this message
Leo Arias (elopio) wrote :
description: updated
Revision history for this message
Leo Arias (elopio) wrote :

Joe, what is that comment about { and } instead of ` ?

Revision history for this message
Sergio Schvezov (sergiusens) wrote : Re: [Bug 1592133] Re: The snap parts wiki is ugly. Add code markers around the wiki and add support in the parser.

El 27/06/16 a las 12:25, Leo Arias escribió:
> Joe, what is that comment about { and } instead of ` ?
>
It is related to the fact that I got used to markdown "```" instead of our wiki's "{{{" and "}}}" for this type raw text :-)

Revision history for this message
Steve Langasek (vorlon) wrote : Please test proposed package

Hello Joe, or anyone else affected,

Accepted snapcraft into xenial-proposed. The package will build now and be available at https://launchpad.net/ubuntu/+source/snapcraft/2.12 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See https://wiki.ubuntu.com/Testing/EnableProposed for documentation how to enable and use -proposed. Your feedback will aid us getting this update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug, mentioning the version of the package you tested, and change the tag from verification-needed to verification-done. If it does not fix the bug for you, please add a comment stating that, and change the tag to verification-failed. In either case, details of your testing will help us make a better decision.

Further information regarding the verification process can be found at https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in advance!

tags: added: verification-needed
Revision history for this message
Leo Arias (elopio) wrote :

Tested in an up-to-date xenial:

- enabled -proposed
- update snapcraft-parser to 2.12
- snapcraft-parser --index https://wiki.ubuntu.com/snapcraft/parts?action=raw <- the wiki contains {{{ and }}}, and the parts are parsed correctly

I'm going to mark this as verified, thanks Steve!

tags: added: verification-done
removed: verification-needed
Changed in snapcraft:
status: Fix Committed → Fix Released
Revision history for this message
Chris J Arges (arges) wrote : Update Released

The verification of the Stable Release Update for snapcraft has completed successfully and the package has now been released to -updates. Subsequently, the Ubuntu Stable Release Updates Team is being unsubscribed and will not receive messages about this bug report. In the event that you encounter a regression using the package from -updates please report a new bug using ubuntu-bug and tag the bug report regression-update so we can easily find any regressions.

Mathew Hodson (mhodson)
affects: Ubuntu Xenial → snapcraft (Ubuntu Xenial)
Changed in snapcraft (Ubuntu Xenial):
importance: Undecided → Medium
status: New → Fix Released
Changed in snapcraft (Ubuntu Yakkety):
status: New → Fix Released
importance: Undecided → Medium
Changed in snapcraft (Ubuntu):
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.