-
Notifications
You must be signed in to change notification settings - Fork 51
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: add engine docs to docs.ooni.org #1634
Conversation
.github/workflows/build_docs.yml
Outdated
path: "ooni-docs" | ||
|
||
- name: Update docs | ||
run: cp -R dist/docs/* ooni-docs/src/content/docs/mydocs/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wherever it says mydocs
it should instead say probe
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a good start, but it's missing critical pieces to make it mergeable.
Basically I would do a find . -type f -name "*.md"
in the root of probe-cli
and then figure out where they should live on docs.ooni.org and come up with reasonable slugs and titles for each of them.
You can ignore readmes that are very redundant, things like this one: https://github.com/ooni/probe-cli/blob/master/internal/cmd/README.md, which have basically not relevant content in them. However things like this: https://github.com/ooni/probe-cli/blob/master/internal/tutorial/dslx/chapter01/README.md should be included in docs.ooni.org and placed in the right place (eg. /probe-engine/dslx/tutorials/chapter-1)
Moreover the directory of the docs should not be mydocs
, but rather should be probe
or probe-engine
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are only pushing the following docs to docs.ooni.org for now: docs/design/*
, docs/releasing.md
, pkg/oonimkall/*
and README.md
.
Thanks for the review! I have pushed the desired changes. As proposed, we have renamed the content directory for |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me. We should also add probe-engine to the sidebar, but that can be done directly in the ooni/docs repo.
Checklist
Description
This diff introduces workflow to show docs in
ooni/probe-cli
on docs.ooni.org