Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Add developer docs preview deployments #679

Merged
merged 5 commits into from May 5, 2022

Conversation

sarayourfriend
Copy link
Contributor

Description

It's the same idea as our storybook/tailwind configuration deployment previews in the frontend, but with the developer docs that are published from the API 😁

Testing Instructions

Check the PR comments and try the preview link.

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.

@sarayourfriend sarayourfriend added 🟩 priority: low Low priority and doesn't need to be rushed 🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users labels May 4, 2022
@openverse-bot openverse-bot added this to In progress in Openverse PRs May 4, 2022
@github-actions
Copy link

github-actions bot commented May 4, 2022

API Developer Docs Preview: Ready

https://wordpress.github.io/openverse-api/_preview/679

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.

@WordPress WordPress deleted a comment from github-actions bot May 4, 2022
@WordPress WordPress deleted a comment from github-actions bot May 4, 2022
@WordPress WordPress deleted a comment from github-actions bot May 4, 2022
@sarayourfriend sarayourfriend marked this pull request as ready for review May 4, 2022 21:37
@sarayourfriend sarayourfriend requested a review from a team as a code owner May 4, 2022 21:37
@openverse-bot openverse-bot moved this from In progress to Needs review in Openverse PRs May 4, 2022
Copy link
Contributor

@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.

I seriously love this ⭐ If this gets in before #678, I'll rebase it and we can test it out!

@sarayourfriend sarayourfriend enabled auto-merge (squash) May 5, 2022 06:36
@sarayourfriend
Copy link
Contributor Author

@AetherUnbound I think I want to write a marketplace action for it!

@AetherUnbound
Copy link
Contributor

That would be amazing! 😮 ✨

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.

This is awesome! Thank you for adding more previews for PRs.

Openverse PRs automation moved this from Needs review to Reviewer approved May 5, 2022
@sarayourfriend sarayourfriend merged commit f90f1e2 into main May 5, 2022
@sarayourfriend sarayourfriend deleted the add/dev-docs-pr-previews branch May 5, 2022 19:05
Openverse PRs automation moved this from Reviewer approved to Merged! May 5, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
🤖 aspect: dx Concerns developers' experience with the codebase 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟩 priority: low Low priority and doesn't need to be rushed
Projects
No open projects
Openverse PRs
  
Merged!
Development

Successfully merging this pull request may close these issues.

None yet

3 participants