-
Notifications
You must be signed in to change notification settings - Fork 300
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
Add docs website #215
Conversation
cc6be70
to
b509e98
Compare
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.
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 |
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.
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
docs/content/development/building.md
Outdated
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. |
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 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 |
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.
"You must grab ..." here contradicts "You can grab ..." in the previous paragraph.
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.
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}` |
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.
How about putting the steps point by point?
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.
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.
6d5318d
to
05b0273
Compare
@@ -1,3 +1,5 @@ | |||
![docker and kubernetes interact](docs/static/logo.svg) |
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.
The link should be docs/static/images/logo.svg
Initial changes to add a static website for the project's documentation
You can view these changes by checking them out and running
In the project's root directory. The page with then be available at
localhost:1313
Related issue:
#212
#154