Dev docusaurus #104
Dev docusaurus #104
Conversation
There was a problem hiding this comment.
Gave it a spin locally, it's wonderful, looking forward for it to land. I suppose it will land after the other PRs.
Maybe it makes sense to separate commits more granularly, into a commit that adds new files, a commit that changes filepath of existing content, and a commit that changes things inside of the new content. That way, a git rebase main from this branch may be easier. But this is all personal preference for updating this PR down the line.
There was a problem hiding this comment.
I just ran the code locally and the new version is great!
I have only one question. Should we push the node_modules directory ? It seems something that should not be pushed to the remote. I think the developers can call npm install at the first time and move on. No need to commit this. I'm asking this because in my local env I had to remove the directory and call npm install again.
However, if this is a best practice in the npm world or if you will do more changes, ignore this comment. ;)
docs/tasks.md
Outdated
| @@ -17,7 +17,7 @@ The Kubewarden Policy Hub hosts policies contributed by the community. For examp | |||
|
|
|||
| As shown in the picture below, once you find the policy to be tested, you can copy the registry path<sup>1</sup> or download<sup>2</sup> the `Wasm` binary containing the policy and additional metadata: | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
I can't build it because it doesn't find this image
There was a problem hiding this comment.
I run it locally and I love it!! I had a few problems building the site:
SyntaxError: /home/raul/Development/kubewarden/docs-1/docs/writing-policies/spec/04-mutating-policies.md: Unexpected token, expected "}" (139:11)
To fix it I had to remove this table
Also I had to remove this image, as it couldn't be found.
Not sure if I'm doing something wrong or I'm missing something here, I just run yarn install and then yarn start
|
Thank you! It looks beautiful and well organized. I have the same couple of issues @raulcabello points to. I'm also running it through I went through all the pages and I found some small issues, not sure how you want them to be reported. |
|
The issue with the mutating page s because I re-added it and we might need to format it to fit markdown perfectly. @raulcabello & @ereslibre : thank you for flagging it. @ereslibre : You can either let me know here itself. |
README.md
Outdated
| @@ -1,2 +1,33 @@ | |||
| This repo contains the source of the Kubewarden documentation, the rendered manual | |||
| can be found [here](https://docs.kubewarden.io/). | |||
| # harvesterhci.io | |||
docusaurus.config.js
Outdated
| className: "navbar__docs", | ||
| }, | ||
| { | ||
| href: "https://github.com/harvester/harvester", |
package.json
Outdated
| @@ -0,0 +1,43 @@ | |||
| { | |||
| "name": "harvesterhci", | |||
package.json
Outdated
| ] | ||
| }, | ||
| "main": "index.js", | ||
| "repository": "https://github.com/harvester/harvester.github.io.git", |
For docusaurus GH workflow
There was a problem hiding this comment.
It looks amazing, thank you! Some comments:
- Here there's a command that has to be boxed (at the end of the screnshot)
- I think we could pretty format and color YAML files where applicable
I understand that we cannot do so when YAML files are embedded in a kubectl apply -f - command, but that's fine, I only mean in this case, where the YAML file appears alone.
- Along the lines of the previous point, does docusaurus support Rust highlighting?
- I think the protocol contracts would be more readable with a monospaced font
Thank you, I love this version!
That falls on me, I convinced @jvanz to change all the markdown blocks in that page to |
Description
Fix #XXX
Test
To test this pull request, you can run the following commands:
Additional Information
Tradeoff
Potential improvement