search

quintilesims / layer0

Build, Manage, and Deploy Your Applications
Apache License 2.0
44 stars 20 forks source link

Release candidate doc fixes #485

Closed jparsons04 closed 6 years ago

jparsons04 commented 6 years ago

What does this pull request do? Uses new version of Mkdocs and mkdocs-material to generate layer0.ims.io documentation. Fixes formatting issues in cli reference pages. Removes unnecessary HTML in markdown files. Fixes broken links.

How should this be tested? from docs-src run make build && make serve. Look over the documentation locally after the docs are served.

Using mkdocs v0.17.2 and mkdocs-material v2.3.0

nehayward commented 6 years ago

Should we change the terraform prerequisite to v0.11+ ?

terraform-plugin.md

## Prerequisites
- **Terraform v0.9.4+** ([download](https://www.Terraform.io/downloads.html)), accessible in your system path.
jparsons04 commented 6 years ago

@nehayward I wasn't sure about changing that in case we still wanted to say we still support older versions of Terraform.

diemonster commented 6 years ago

this is more of a [nit] than anything, but the cut'n'paste boxes are available for console output, but not for commands that we would expect users to need cut'n'paste with.

diemonster commented 6 years ago

something @nehayward and @jparsons04 already called out, but the pencil edit icon should be removed from the main page, etc. I'm guessing there's a param you can specify for the document source directory if we wanted those links to resolve to something...

jparsons04 commented 6 years ago

I was able to resolve the edit icon thing in my most recent commit @diemonster