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

Add more info about reusable parts. #527

Merged
merged 4 commits into from
Jun 23, 2016
Merged

Conversation

josepht
Copy link
Contributor

@josepht josepht commented May 27, 2016

Add link to the parts wiki in serveral places and add a section to
the parts documentation explaining how to reuse parts.

LP: #1582499

@snappy-m-o
Copy link

Can one of the admins verify this patch?

1 similar comment
@snappy-m-o
Copy link

Can one of the admins verify this patch?

[the wiki](https://wiki.ubuntu.com/Snappy/Parts) and the content from there will be
used to build the part locally. As the number of published parts increases writing
a snapcraft.yaml file will get easier as one would simply include a set of published
parts and their app specific part(s).
Copy link
Collaborator

Choose a reason for hiding this comment

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

we should probably document how parts are to be defined here. Maybe not just right now.

Copy link
Contributor

Choose a reason for hiding this comment

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

I find that last "and their app specific part(s)" confusing.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated. Please let me know if it's still unclear or confusing.

[the wiki](https://wiki.ubuntu.com/Snappy/Parts) and reused by other snapcraft.yaml
files. A part that does not include the 'plugin' option will be searched for on
[the wiki](https://wiki.ubuntu.com/Snappy/Parts) and the content from there will be
used to build the part locally. As the number of published parts increases writing
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you are missing a comma:
As the number of published parts increases, writing

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Indeed, thanks.

@come-maiz
Copy link
Contributor

In markdown you can define the link once (generally at the bottom) with something like [wiki]: https://wiki.ubuntu.com/Snappy/Parts, and make use of it on the rest of the document with [the wiki][wiki]. Then you won't have to duplicate the url everywhere.

@josepht josepht force-pushed the bug_1582499 branch 2 times, most recently from 31543dd to 132d51f Compare June 2, 2016 01:28
@come-maiz
Copy link
Contributor

👍

@sergiusens
Copy link
Collaborator

I am thinking of leaving this open until we have the new formatting in place which the parser would grab.

@josepht
Copy link
Contributor Author

josepht commented Jun 13, 2016

The travis errors look to me like infrastructure failures not test failures.

@snappy-m-o
Copy link

Can one of the admins verify this patch?

5 similar comments
@snappy-m-o
Copy link

Can one of the admins verify this patch?

@snappy-m-o
Copy link

Can one of the admins verify this patch?

@snappy-m-o
Copy link

Can one of the admins verify this patch?

@snappy-m-o
Copy link

Can one of the admins verify this patch?

@snappy-m-o
Copy link

Can one of the admins verify this patch?

@come-maiz
Copy link
Contributor

👍

because one would simply include a set of published parts and the local part(s)
specific to the snap being created.

[wiki]: https://wiki.ubuntu.com/Snappy/Parts
Copy link
Collaborator

Choose a reason for hiding this comment

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

mind updating this? Also mention the format a bit

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated. I added an explanation of the wiki entry format and an example. I also added a note saying it can take up to an hour for the wiki update to become available to snapcraft.

Add link to the parts wiki in serveral places and add a section to
the parts documentation explaining how to reuse parts.

LP: #1582499
* Create a reusable link for the wiki.
@sergiusens sergiusens merged commit 8a64112 into canonical:master Jun 23, 2016
@come-maiz
Copy link
Contributor

thanks Joe! 👍

@josepht josepht deleted the bug_1582499 branch July 13, 2016 13:53
kalikiana pushed a commit to kalikiana/snapcraft that referenced this pull request Apr 6, 2017
Add link to the parts wiki in serveral places and add a section to
the parts documentation explaining how to reuse parts.

LP: #1582499
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.

4 participants