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

feat: Docz #134

Merged
merged 33 commits into from
Jan 8, 2020
Merged

feat: Docz #134

merged 33 commits into from
Jan 8, 2020

Conversation

sh0rez
Copy link
Member

@sh0rez sh0rez commented Dec 19, 2019

Switches the markdown renderer from mkdocs to https://docz.site. This new thing is React and Gatsbyjs based, giving us much more possibilities about the rendering. Especially it now uses the vscode highlight engine, so Jsonnet highlighting works.

Furthermore I have written an entire tutorial to get new users started much easier.

PS: Don't worry, the +16k is related to yarn.lock (wtf)

@sh0rez sh0rez added component/docs Improvements or additions to documentation kind/enhancement Improve something existing labels Dec 19, 2019
@sh0rez sh0rez requested a review from rfratto December 19, 2019 18:16
@sh0rez sh0rez self-assigned this Dec 19, 2019
Copy link
Contributor

@malcolmholmes malcolmholmes left a comment

Choose a reason for hiding this comment

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

This all looks great!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/docs/diff-strategy.md Outdated Show resolved Hide resolved
docs/docs/installation.md Show resolved Hide resolved
docs/docs/introduction.md Outdated Show resolved Hide resolved
docs/docs/tutorial/k-lib.md Outdated Show resolved Hide resolved
docs/docs/tutorial/k-lib.md Outdated Show resolved Hide resolved
docs/docs/tutorial/overview.md Outdated Show resolved Hide resolved
docs/docs/tutorial/refresher.md Outdated Show resolved Hide resolved
examples/prom-grafana/lib/ksonnet-util/kausal.libsonnet Outdated Show resolved Hide resolved
Switches from the docz wrapper to plain gatsby (much more stable)
Copy link
Contributor

@malcolmholmes malcolmholmes left a comment

Choose a reason for hiding this comment

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

This all looks great!

@sh0rez
Copy link
Member Author

sh0rez commented Dec 21, 2019

There we go @malcolmholmes, applied your review feedback.

Unfortunately, gatsby and docz seem to crash in Netlify, though I am not sure why, as it works locally. Don't have enough JavaScript knowledge to properly debug :( It works now. Was related to vscode-marketplace rate limiting (gatsby was downloading the theme on each build) .. vendored into tree here, works now

@sh0rez
Copy link
Member Author

sh0rez commented Jan 6, 2020

Things to be done:

@malcolmholmes
Copy link
Contributor

Here's some review thoughts:

  • On the homepage, we say "used at Grafana for our". I would suggest we say "used at Grafana for their". The reason for "their" is it allows a potential contributor to identify with the project more easily.
  • We really need 'next/previous' links in the tutorial. It is confusing otherwise working out what page to read next.
  • The "Import Paths" and "Installing and Publishing" links don't point to pages.

docs/docs/tutorial/abstraction.md Outdated Show resolved Hide resolved
docs/docs/jsonnet/overview.md Outdated Show resolved Hide resolved
docs/docs/faq.md Outdated Show resolved Hide resolved
Co-authored-by: Malcolm Holmes mdh@odoko.co.uk
Installation of ksonnet-lib is automated, no need to elaborate it anymore
Simplified it a lot, as Tanka automatically does this now.
@sh0rez sh0rez merged commit 65595a9 into master Jan 8, 2020
@sh0rez sh0rez deleted the docz branch January 8, 2020 10:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/docs Improvements or additions to documentation kind/enhancement Improve something existing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants