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

Better docs #951

Merged
merged 1 commit into from
Oct 11, 2019
Merged

Better docs #951

merged 1 commit into from
Oct 11, 2019

Conversation

johnSchnake
Copy link
Contributor

@johnSchnake johnSchnake commented Oct 10, 2019

Improves a number of docs pages and the organization of them.

Fixes #919

Special notes for your reviewer:

Release note:

NONE

README.md Outdated Show resolved Hide resolved
site/_data/master-toc.yml Outdated Show resolved Hide resolved
site/_data/master-toc.yml Outdated Show resolved Hide resolved
site/_data/master-toc.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@zubron zubron left a comment

Choose a reason for hiding this comment

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

These changes are looking great, definitely a big improvement 👍

@johnSchnake
Copy link
Contributor Author

The png i copied seems to not work well there; I'm guessing the blogpost had better css/layout to scale it.

Will see what I can do; for me it is overflowing by a lot.

@johnSchnake
Copy link
Contributor Author

I ended up just scaling the image to be about the same as the existing image so at least we have the same experience more or less.

@johnSchnake johnSchnake marked this pull request as ready for review October 11, 2019 17:22
@johnSchnake
Copy link
Contributor Author

I'd like to add a FAQ as well at some point but that will be another issue; this is progress in the right direction at least.

Let me know any other issues you find.

Copy link
Contributor

@zubron zubron left a comment

Choose a reason for hiding this comment

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

I think this looks great. Thank you for adding these! An FAQ would be good, but I think it can be added later. If you want to submit this as is, go for it! 👍

Improves a number of docs pages and the organization of them.

Fixes #919

Signed-off-by: John Schnake <[email protected]>
@johnSchnake
Copy link
Contributor Author

Removed a small section on the readme that just links to other pages (we talked about that when the ticket first came up; there was also a broken link there too).

Merging now that the docs checks and preview look good.

@johnSchnake johnSchnake merged commit 6077455 into vmware-tanzu:master Oct 11, 2019
@johnSchnake johnSchnake deleted the betterDocs branch October 11, 2019 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fixup docs
2 participants