install: remove from menu, update in docs (nav and content) #381
Conversation
content/docs/sidebar.json
Outdated
| "label": "Install as a Package", | ||
| "slug": "install" | ||
| }, | ||
| { | ||
| "label": "Command Reference", | ||
| "slug": "ref", |
There was a problem hiding this comment.
Minor: Moved this entry one place up. Not a strong opinion, but I think it makes more sense as it's similar to the other lose pages (guides, I guess?).
content/docs/install.md
Outdated
| Installing CML directly in CI environment is not typically needed, as comes | ||
| pre-installed in our provided [Docker Images]. Alternatively, GitHub users can | ||
| use the [`setup-cml` action]. |
There was a problem hiding this comment.
Added an admon to clarify that you probably don't want to do this.
There was a problem hiding this comment.
Are the changes to this file (and nav) good at least? If you don't want to remove the confusing menu entry.
Otherwise feel free to take this over, close it, etc. Thanks @iterative/cml
content/docs/install.md
Outdated
| <details> | ||
|
|
||
| Instructions for installing [Node.js](https://nodejs.org) and its package | ||
| manager `npm` can be found below. | ||
| ### Installing Node.js | ||
|
|
||
| <toggle> | ||
| <tab title="GitLab"> |
There was a problem hiding this comment.
Hid the 3rd party tool docs (not ideal to maintain, but I see how it can be a useful tip here).
There was a problem hiding this comment.
BTW is this missing a BitBucket tab?
|
Last note: not sure what's the point of the big Download button in the home page:
Can we kill it? |
Link Check ReportAll 4 links passed! |
|
I think we needed this for a patent application. It probably over and we can remove it safely. |
|
Didn't quite get any of the feedback TBH 😬 |
jorgeorpinel
force-pushed
the
nav--menu
branch
from
9d22b7c
to
bbf58dd
Compare
|
Oops killed this PR accidentally. Re-done in #447. |
I think it's confusing to promote the idea of direct installation for CML since it's not the happy path, so I'm proposing to clarifying that in the docs, and to remove the big menu button. Other notes for review below...