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

chore: adding docs #3162

Merged
merged 12 commits into from
Oct 16, 2023
Merged

chore: adding docs #3162

merged 12 commits into from
Oct 16, 2023

Conversation

signorecello
Copy link
Contributor

@signorecello signorecello commented Oct 14, 2023

Description

This PR merges the noir docs into the Noir monorepo.

Problem*

Docs are hard to maintain because they live in a separate repo, so according to our discussions, we're moving it to the monorepo.

Summary*

There are many files, but not so many changes:

  • All the docs were copied here as of 06b8be56f89452e1d640413fa5c7e1f1b3baa59d
  • Wrote a custom github action that:
    • Runs a script querying the deploy status for this particular site
    • Succeeds or fails and outputs that
  • Wrote a workflow that:
    • Triggers a deployment for this particular head_ref
    • Gets a deploy preview url
    • Adds a default message with a status badge
    • Uses the custom action above to query the result
    • Conditionally returns more info and a debatably funny meme
  • Deprecated the old "doc needed" workflow

The merges to master should be triggered by Netlify without needing a hook

Documentation

Additional Context

I think we should probably put the build hook in a secret env. Netlify doesn't tell us to, but maybe it's not cool to just provide it, even though it would only work with existent branches. Malicious people could maybe abuse it to eat our build minutes by flooding us with new branches, making small changes, and triggering deployments?

SiteID is completely public and is easily retrievable from the status badge, but I'd probably make it into a env variable so it's easier to change in case we need to

Added these 👆 as secrets because we have nothing to lose 🙂

In case you like the memes, we can probably store them, as imgflip will probably take them down sometime

@signorecello signorecello added the documentation Improvements or additions to documentation label Oct 16, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 16, 2023

It's Alive!

I'm a bot, beep boop 🤖

Deployment Status: Success!

Netlify Status

Preview

🌐 View Deployment Preview

@kevaundray kevaundray enabled auto-merge October 16, 2023 17:33
@kevaundray kevaundray added this pull request to the merge queue Oct 16, 2023
Merged via the queue into master with commit 5c896b6 Oct 16, 2023
28 checks passed
@kevaundray kevaundray deleted the zpedro/docs_monorepo branch October 16, 2023 17:57
Sakapoi pushed a commit to Sakapoi/noir_fork that referenced this pull request Oct 19, 2023
Co-authored-by: kevaundray <kevtheappdev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants