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: add engine docs to docs.ooni.org #1634

Merged
merged 3 commits into from
Jul 4, 2024
Merged

feat: add engine docs to docs.ooni.org #1634

merged 3 commits into from
Jul 4, 2024

Conversation

DecFox
Copy link
Contributor

@DecFox DecFox commented Jul 3, 2024

Checklist

  • I have read the contribution guidelines
  • reference issue for this pull request:
  • if you changed anything related to how experiments work and you need to reflect these changes in the ooni/spec repository, please link to the related ooni/spec pull request:
  • if you changed code inside an experiment, make sure you bump its version number

Description

This diff introduces workflow to show docs in ooni/probe-cli on docs.ooni.org

path: "ooni-docs"

- name: Update docs
run: cp -R dist/docs/* ooni-docs/src/content/docs/mydocs/
Copy link
Member

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

scripts/build_docs.sh Outdated Show resolved Hide resolved
Copy link
Member

@hellais hellais left a 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

Copy link
Contributor Author

@DecFox DecFox Jul 4, 2024

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.

@DecFox
Copy link
Contributor Author

DecFox commented Jul 4, 2024

Thanks for the review! I have pushed the desired changes. As proposed, we have renamed the content directory for ooni/probe-cli docs to be probe-engine here: https://github.com/ooni/probe-cli/pull/1634/files#diff-4dfe935b4852393622c2b414783d1d11e1a868fd8485709124d90208fa61ec8bR26

Copy link
Member

@hellais hellais left a 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.

@DecFox DecFox merged commit 758301c into ooni:master Jul 4, 2024
16 of 18 checks passed
@DecFox DecFox deleted the docs branch July 4, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants