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

Update documentation system to cover all projects #443

Merged
merged 9 commits into from
Feb 23, 2023
Merged

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Feb 20, 2023

Description

This PR updates the documentation system by

  • decoupling if from the API to represent the broader goal of documenting the entire repo
  • updating the Quickstart guide to run the ingestion server, API and also frontend
  • modifying the build action to reflect these changes
  • adds the missing page 'Zero Downtime and Database Management' to the docs

This PR also removes the steps for installing API and ingestion server dependencies from the just install recipe. Because they are run using Docker containers, their dependencies need not be installed on the host.

Finally, the PR also makes some necessary changes to the workflow to maintain the logical execution and chanining.

Testing Instructions

See the deployed documentation preview and compare it with the old docs.

Checklist

  • My pull request has a descriptive title (not a vague title like
    Update index.md).
  • My pull request targets the default branch of the repository (main) or
    a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible
    errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb added 🟧 priority: high Stalls work on the project or its dependents 🌟 goal: addition Addition of new feature 📄 aspect: text Concerns the textual material in the repository labels Feb 20, 2023
@github-actions
Copy link

github-actions bot commented Feb 20, 2023

Full-stack documentation: Ready

https://WordPress.github.io/openverse/_preview/443

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@dhruvkb dhruvkb marked this pull request as ready for review February 20, 2023 23:18
@dhruvkb dhruvkb requested a review from a team as a code owner February 20, 2023 23:18
documentation/justfile Outdated Show resolved Hide resolved
documentation/justfile Outdated Show resolved Hide resolved
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Nice! There are some error messages about missing link ids in the Search algorithm page, but they are not related to this PR. The documentation builds well, and everything is linked on the single site 🎉

@obulat obulat mentioned this pull request Feb 22, 2023
16 tasks
Co-authored-by: Olga Bulat <obulat@gmail.com>
Copy link
Collaborator

@AetherUnbound AetherUnbound 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 and works great, I love it!

justfile Show resolved Hide resolved
@dhruvkb dhruvkb merged commit 185d9e3 into main Feb 23, 2023
@dhruvkb dhruvkb deleted the monorepo_docs branch February 23, 2023 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 aspect: text Concerns the textual material in the repository 🌟 goal: addition Addition of new feature 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants