-
Notifications
You must be signed in to change notification settings - Fork 327
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
Promote v2 content in docs for deploying with GH Pages #3013
Conversation
Signed-off-by: merobi-hub <merobi@gmail.com>
❌ Deploy Preview for peppy-sprite-186812 failed.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3013 +/- ##
=========================================
Coverage 81.18% 81.18%
Complexity 1506 1506
=========================================
Files 268 268
Lines 7356 7356
Branches 325 325
=========================================
Hits 5972 5972
Misses 1226 1226
Partials 158 158 ☔ View full report in Codecov by Sentry. |
@merobi-hub Maybe we just remove the |
Signed-off-by: merobi-hub <merobi@gmail.com>
Signed-off-by: merobi-hub <merobi@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
New year, new site! 👍
…t#3013) * static.yml in .github for publishing docs using github actions. Signed-off-by: merobi-hub <merobi@gmail.com> * Fix path. Signed-off-by: merobi-hub <merobi@gmail.com> * Promote v2 docs site content to docs dir. Signed-off-by: merobi-hub <merobi@gmail.com> * Remove netlify.toml. Signed-off-by: merobi-hub <merobi@gmail.com> --------- Signed-off-by: merobi-hub <merobi@gmail.com>
…t#3013) * static.yml in .github for publishing docs using github actions. Signed-off-by: merobi-hub <merobi@gmail.com> * Fix path. Signed-off-by: merobi-hub <merobi@gmail.com> * Promote v2 docs site content to docs dir. Signed-off-by: merobi-hub <merobi@gmail.com> * Remove netlify.toml. Signed-off-by: merobi-hub <merobi@gmail.com> --------- Signed-off-by: merobi-hub <merobi@gmail.com>
…t#3013) * static.yml in .github for publishing docs using github actions. Signed-off-by: merobi-hub <merobi@gmail.com> * Fix path. Signed-off-by: merobi-hub <merobi@gmail.com> * Promote v2 docs site content to docs dir. Signed-off-by: merobi-hub <merobi@gmail.com> * Remove netlify.toml. Signed-off-by: merobi-hub <merobi@gmail.com> --------- Signed-off-by: merobi-hub <merobi@gmail.com>
Problem
We need a new hosting solution for the docs and landing pages.
Solution
OpenLineage uses GitHub, and it works well. Our use case is slightly different because we need to deploy a subdirectory (
v2
in docs). GitHub Actions allows you to set an arbitrary path as the source in a YML file in .github/workflows. This adds the YML (auto-generated by GH except for the path) to enable us to publish the site using GH, which is currently not possible using the UI. After this is enabled, we can open a ticket with the LF to point the domain to GH. Instructions for doing this are here. Note: the domain has to be removed from another repo in the org (presumably the website repo) before we can configure the new site, and I don't have access to that repo's settings to do this.Closes: #3014
One-line summary: promote v2 content in docs for GH Pages deploys
Checklist
CHANGELOG.md
(Depending on the change, this may not be necessary)..sql
database schema migration according to Flyway's naming convention (if relevant)