Migrate docs to Vuepress #442
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rbren
requested review from
baderbuddy,
jordandoig and
makoscafee
as code owners
Codecov Report
@@ Coverage Diff @@
## master #442 +/- ##
=======================================
Coverage 45.92% 45.92%
=======================================
Files 12 12
Lines 699 699
=======================================
Hits 321 321
Misses 324 324
Partials 54 54 Continue to review full report at Codecov.
|
baderbuddy
approved these changes
Nov 19, 2020
.github/workflows/build-site.yml
Outdated
|
|
||
| strategy: | ||
| matrix: | ||
| node-version: [12.x] |
There was a problem hiding this comment.
Could we bump it up to 14?
.github/workflows/build-site.yml
Outdated
| node-version: ${{ matrix.node-version }} | ||
| - run: cd docs-md | ||
| - run: npm ci | ||
| - run: npm install |
There was a problem hiding this comment.
npm ci and npm install should be redundant
.github/workflows/build-site.yml
Outdated
| - run: npm run check-links | ||
| - run: | | ||
| git config user.email "insights@fairwinds.com" | ||
| git config user.name "Circle CI" |
There was a problem hiding this comment.
Since this is running in a GitHub workflow we probably don't want to use the name Circle CI. I wonder if for email address we should use opensource@fairwinds.com?
There was a problem hiding this comment.
Hah, copypasta. Fixed, thanks!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a first pass at migrating the Polaris docs to Vuepress. Lots of reorganizing as well.
Let me know if there are any docs that I missed.
https://polaris.docs.fairwinds.com/
TODO: switch the docs settings to use the master branch once this is merged.