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 docs website #215

Merged
merged 6 commits into from
Aug 8, 2023
Merged

Conversation

nwneisen
Copy link
Collaborator

@nwneisen nwneisen commented Jul 21, 2023

Initial changes to add a static website for the project's documentation

You can view these changes by checking them out and running

make docs

In the project's root directory. The page with then be available at localhost:1313

Related issue:
#212
#154

@nwneisen nwneisen added the documentation Improvements or additions to documentation label Jul 21, 2023
README.md Outdated Show resolved Hide resolved
@nwneisen nwneisen changed the title #212 Add docs website Add docs website Jul 25, 2023
Copy link

@RaunakShah RaunakShah left a comment

Choose a reason for hiding this comment

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

Some minor comments. Thank you for all the hard work here!

version, Mirantis Container Runtime (MCR), will be CRI compliant. This means that you can continue to build Kubernetes
based on the Docker Engine as before, just switching from the built in dockershim to the external one.

Mirantis and Docker intend to work together on making sure it continues to work as well as before and that it

Choose a reason for hiding this comment

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

What about moving this before "For Mirantis customers ..." so that it maintains flow with the partnership between Mirantis and Docker?
Then we can highlight the (non) changes to Mirantis customers in the next paragraph

You can then run it directly or install it using the manual process above.

To build for a specific architecture, add `ARCH=` as an argument, where `ARCH`
is a known build target for Go.

Choose a reason for hiding this comment

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

Can you add an example command here?

by setting up a minikube cluster since it uses `cri-dockerd` by default. You can
grab the latest version from their repo's releases page:

> You must grab the latest release from their release's page. The version

Choose a reason for hiding this comment

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

"You must grab ..." here contradicts "You can grab ..." in the previous paragraph.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We actually had a discussion in another PR and we can direct them to minikube's getting started page for installation. I took out both of these "grabs"

weight: 3
---

The default network plugin for `cri-dockerd` is set to `cni` on Linux. To change this, `--network-plugin=${plugin}`

Choose a reason for hiding this comment

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

How about putting the steps point by point?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The tricky part here is that it's actually only a couple steps but worded badly. This is something from the original docs. I'll see if I can make it easier to understand.

@nwneisen nwneisen merged commit b9f52ee into Mirantis:master Aug 8, 2023
2 checks passed
@@ -1,3 +1,5 @@
![docker and kubernetes interact](docs/static/logo.svg)
Copy link
Contributor

Choose a reason for hiding this comment

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

The link should be docs/static/images/logo.svg

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants