/snapcraft

General documentation update #178

Merged
merged 1 commit into from Jan 5, 2016

Conversation

Reviewers
No reviews
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
3 participants
@sergiusens @kyrofa @elopio
@sergiusens
Collaborator

sergiusens commented Dec 18, 2015

Most of these changes are to reflect the new cli, but there are also
other minor corrections in here.

Signed-off-by: Sergio Schvezov sergio.schvezov@canonical.com
docs/snapcraft-advanced-features.md
@@ -171,10 +171,9 @@ thoughts on services and their security, visit the
### Limiting the number of installed files
-To check the list of files included in your snap, you can use `dpkg -c` on
@kyrofa

kyrofa Dec 21, 2015

Member

Are we completely losing this functionality with the move to squashfs? Do we have anything equivalent? It was quite handy to be able to open the .snap in the Archive Manager, or use dpkg -c.

@sergiusens

sergiusens Jan 4, 2016

Collaborator

found unsquashfs -l

@kyrofa
Member

kyrofa commented Dec 21, 2015

Overall this looks pretty good. I know we have some other documentation (the ROS one immediately comes to mind) that still says to run snapcraft with no arguments to create the .snap. Should the rest of the docs be updated here?

@kyrofa kyrofa added the enhancement label Dec 23, 2015

@sergiusens
Collaborator

sergiusens commented Jan 4, 2016

@kyrofa I've updated the ros mention as well
docs/get-started.md
@@ -10,6 +10,9 @@ technology, we recommend to use the latest classic Ubuntu Long-Term Support
those not using an Ubuntu machine (and you should), you can use a VM
(VirtualBox, VMware, Vagrant) to execute your Ubuntu development host.
+This version of snapcraft only works on xenial, for previous versions of
@elopio

elopio Jan 5, 2016

Member

being a pita, I would replace xenial with something like Ubuntu 16.04 (xenial)

docs/get-started.md
@@ -10,6 +10,9 @@ technology, we recommend to use the latest classic Ubuntu Long-Term Support
those not using an Ubuntu machine (and you should), you can use a VM
(VirtualBox, VMware, Vagrant) to execute your Ubuntu development host.
+This version of snapcraft only works on xenial, for previous versions of
+snapcraft, refer to the 1.x documentation.
@elopio

elopio Jan 5, 2016

Member

maybe a link to the 1.x branch in github?

@elopio
Member

elopio commented Jan 5, 2016

lgtm. I just left a couple of ignorable comments.
@kyrofa
Member

kyrofa commented Jan 5, 2016

Yeah, looks good to me too.
@sergiusens
General documentation update 
Most of these changes are to reflect the new cli, but there are also
other minor corrections in here.

Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com>

All checks have passed

2 successful checks
continuous-integration/travis-ci/pr — The Travis CI build passed
Details
coverage/coveralls — Coverage remained the same at 88.736%
Details
2fed9ea

sergiusens added a commit that referenced this pull request Jan 5, 2016

@sergiusens
Merge pull request #178 from sergiusens/general-docs-update 
General documentation update
e9b3139

@sergiusens sergiusens merged commit e9b3139 into snapcore:master Jan 5, 2016
2 checks passed

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 88.736%
Details

@sergiusens sergiusens deleted the sergiusens:general-docs-update branch Mar 1, 2016

kalikiana pushed a commit to kalikiana/snapcraft that referenced this pull request Apr 6, 2017

@sergiusens
Merge pull request #178 from sergiusens/general-docs-update 
General documentation update
f82d311
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment