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

Documentation migration #468

Merged
merged 14 commits into from
May 24, 2023
Merged

Documentation migration #468

merged 14 commits into from
May 24, 2023

Conversation

pieqq
Copy link
Collaborator

@pieqq pieqq commented May 17, 2023

Description

The goal of this PR is to migrate our existing pages to the new docs directory, and do some cleanup. Namely:

  • Update the welcome page with a description of the application
  • Copy *.rst files from checkbnox-ng/docs to docs/ following the proposed structure
  • Remove the starter pack boilerplate

I migrated everything except snappy.rst as I thought it was not relevant anymore (checkbox-snappy is not in use, and the content of that page is basically a mega-tutorial with information present elsewhere).

Resolved issues

CHECKBOX-610

Tests

Tested locally using make run (super useful stuff!)

I checked if images and links worked as before, and it seems OK.

To test locally:

  1. Checkout this branch
  2. Go to the docs/ directory, and run make install
  3. Run make run -> you should be able to access the built documentation locally.

@pieqq pieqq marked this pull request as draft May 17, 2023 06:30
@pieqq pieqq force-pushed the CHECKBOX-610/doc-migration branch from 2db9a55 to 79178e1 Compare May 17, 2023 06:38
@pieqq pieqq requested a review from yphus May 17, 2023 06:54
@pieqq pieqq marked this pull request as ready for review May 17, 2023 06:54
@pieqq
Copy link
Collaborator Author

pieqq commented May 17, 2023

The "Spelling check" steps of our workflow fails because of a lot of technical terms in our pages. Will have to look into that later.

@yphus
Copy link
Contributor

yphus commented May 17, 2023

Good work, just one comment. I'd not create a section for "Project and community" (on the left side bar) but rather add both bugs.rst and contributing.rst as links under the footer section of the main page, right here:

Project and community

Checkbox is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.

    This project follows the Ubuntu Code of Conduct
    Get support
    Join our online chat
    Contribute                                  <-- here
    Reporting bugs                          <-- and here
    Thinking about using Checkbox for your next project? Get in touch!

Copy link
Contributor

@yphus yphus left a comment

Choose a reason for hiding this comment

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

Please add :orphan: to the top of the following files:

  • checkbox/docs/community/bugs.rst
  • checkbox/docs/community/contributing.rst

To avoid a warning at build time:
WARNING: document isn't included in any toctree

@pieqq
Copy link
Collaborator Author

pieqq commented May 23, 2023

Please add :orphan: to the top of the following files:

* checkbox/docs/community/bugs.rst

* checkbox/docs/community/contributing.rst

To avoid a warning at build time: WARNING: document isn't included in any toctree

Done!

Copy link
Contributor

@yphus yphus left a comment

Choose a reason for hiding this comment

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

LGTM

@pieqq pieqq merged commit 4227948 into main May 24, 2023
@pieqq pieqq deleted the CHECKBOX-610/doc-migration branch May 24, 2023 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants