Skip to content

Major docs restructure#3071

Merged
nkubala merged 1 commit intoGoogleContainerTools:masterfrom
nkubala:docs-structure
Oct 17, 2019
Merged

Major docs restructure#3071
nkubala merged 1 commit intoGoogleContainerTools:masterfrom
nkubala:docs-structure

Conversation

@nkubala
Copy link
Copy Markdown
Contributor

@nkubala nkubala commented Oct 16, 2019

This is a major restructuring of our docs pages to improve the flow and readability.

There are many follow up changes that need to be made to the actual content of several of the pages - this PR is purely a restructuring, and kept actual content changes to an absolute minimum. TODOs have been left in spots where follow up work is needed.

The easiest way to review this PR will be to pull the branch, and host the docs site on your local machine by running make preview-docs and visiting http://localhost:1313.

@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Oct 16, 2019
@container-tools-bot
Copy link
Copy Markdown

Please visit http://35.236.79.92:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Oct 16, 2019
@codecov
Copy link
Copy Markdown

codecov bot commented Oct 16, 2019

Codecov Report

Merging #3071 into master will not change coverage.
The diff coverage is n/a.

Copy link
Copy Markdown
Contributor

@balopat balopat left a comment

Choose a reason for hiding this comment

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

nits:

  • Common Workflows and Use Cases -> Main Workflows
  • ordering under Main Workflows should be
    • Continuous Development with Skaffold -> Continuous Development
    • Debugging
    • Continuous Delivery

TODOs should have issues in case we forget them in and have them linked via the TODO shortcode.

@balopat balopat added the docs-modifications runs the docs preview service on the given PR label Oct 16, 2019
@container-tools-bot
Copy link
Copy Markdown

Please visit http://35.236.0.111:1313 to view changes to the docs.

@container-tools-bot container-tools-bot removed the docs-modifications runs the docs preview service on the given PR label Oct 16, 2019
@nkubala nkubala merged commit b87f397 into GoogleContainerTools:master Oct 17, 2019
@nkubala nkubala deleted the docs-structure branch June 17, 2021 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants