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

doc: add Hugo-powered website #188

Merged
merged 9 commits into from
Oct 25, 2017
Merged

Conversation

cyphar
Copy link
Member

@cyphar cyphar commented Oct 8, 2017

Hosted on https://umo.ci/

Signed-off-by: Aleksa Sarai asarai@suse.de

@cyphar cyphar added this to the 0.4.0 milestone Oct 8, 2017
@cyphar cyphar force-pushed the hugo-website branch 2 times, most recently from 554826c to 703d5d9 Compare October 12, 2017 10:21
@cyphar cyphar force-pushed the hugo-website branch 3 times, most recently from 4f375ec to 4546ba0 Compare October 24, 2017 03:44
@cyphar cyphar force-pushed the hugo-website branch 5 times, most recently from e94002b to c6544a2 Compare October 25, 2017 10:05
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>
Copy link
Contributor

@jonboulle jonboulle left a 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"
Copy link
Contributor

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
Copy link
Contributor

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`
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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>
@cyphar
Copy link
Member Author

cyphar commented Oct 25, 2017

LGTM.

@cyphar cyphar merged commit 8e1f3c6 into opencontainers:master Oct 25, 2017
cyphar added a commit that referenced this pull request Oct 25, 2017
  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
@cyphar cyphar deleted the hugo-website branch October 25, 2017 10:38
@cyphar cyphar mentioned this pull request Oct 31, 2017
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.

2 participants