-
Notifications
You must be signed in to change notification settings - Fork 97
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
doc: add Hugo-powered website #188
Conversation
554826c
to
703d5d9
Compare
4f375ec
to
4546ba0
Compare
e94002b
to
c6544a2
Compare
This is a bare Hugo site with no other pages. The theme is "hugo-theme-learn", with the Green variant. At the moment there's no pages visible. Signed-off-by: Aleksa Sarai <asarai@suse.de>
This allows for transparent publishing of our site contents, while also maintaining a mirror in doc/ which is fairly readable. This is mostly just a rename (with some slight modifications to remove the old headers and adding metadata for Hugo). Signed-off-by: Aleksa Sarai <asarai@suse.de>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe quicker to just ship it and I'll clean up myself :-)
@@ -0,0 +1,107 @@ | |||
+++ | |||
title = "Workflow Optimistaion" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Optimisation
+++ | ||
|
||
One of the first things that a user of umoci may notice is that certain | ||
operations can be quite expensive. Most notable, unpack and repack operations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
notably
% umoci tag --image image_build_XYZ:wip final | ||
``` | ||
|
||
Do not dispair however, there is a flag just for you! With `--refresh-bundle` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
despair
``` | ||
|
||
Do not dispair however, there is a flag just for you! With `--refresh-bundle` | ||
it is possible to preform the above operations without needing to do any extra |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
perform
configuration that should be replaced by a user. | ||
|
||
If you wish to create a new image layout (which contains nothing except the | ||
bare minimum to specify that the image is an OCI image), you can do so `umoci |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can do so with
Signed-off-by: Aleksa Sarai <asarai@suse.de>
Signed-off-by: Aleksa Sarai <asarai@suse.de>
Signed-off-by: Aleksa Sarai <asarai@suse.de>
Signed-off-by: Aleksa Sarai <asarai@suse.de>
Signed-off-by: Aleksa Sarai <asarai@suse.de>
Workflow optimisation is quite important for users of umoci, so add some documentation about how --refresh-bundle works. In future, we'll add documentation on umoci-revert (once it's implemented). Signed-off-by: Aleksa Sarai <asarai@suse.de>
We have to copy the files as part of publishing, otherwise several things might break as a result. Signed-off-by: Aleksa Sarai <asarai@suse.de>
LGTM. |
doc: site: add {changelog,contributing} [ci skip] site: add documentation about --refresh-bundle [ci skip] rootless: add notices about common pitfalls [ci skip] CHANGELOG: added note about website [ci skip] hack: add publish script [ci skip] doc: site: add notices about project status [ci skip] doc: site: split out quick-start and introduction [ci skip] doc: restructure to doc/site [ci skip] .site: bare hugo site with theme [ci skip] LGTMs: @cyphar Closes #188
Hosted on https://umo.ci/
Signed-off-by: Aleksa Sarai asarai@suse.de