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

Promote v2 content in docs for deploying with GH Pages #3013

Merged
merged 4 commits into from
Jan 20, 2025
Merged

Conversation

merobi-hub
Copy link
Collaborator

@merobi-hub merobi-hub commented Jan 20, 2025

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.

Note: All database schema changes require discussion. Please link the issue for context.

Closes: #3014

One-line summary: promote v2 content in docs for GH Pages deploys

Checklist

  • You've signed-off your work
  • Your changes are accompanied by tests (if relevant)
  • Your change contains a small diff and is self-contained
  • You've updated any relevant documentation (if relevant)
  • You've included a one-line summary of your change for the CHANGELOG.md (Depending on the change, this may not be necessary).
  • You've versioned your .sql database schema migration according to Flyway's naming convention (if relevant)
  • You've included a header in any source code files (if relevant)

Signed-off-by: merobi-hub <merobi@gmail.com>
Copy link

netlify bot commented Jan 20, 2025

Deploy Preview for peppy-sprite-186812 failed.

Name Link
🔨 Latest commit c0331ed
🔍 Latest deploy log https://app.netlify.com/sites/peppy-sprite-186812/deploys/678eb2f9d8769e0008f3d43c

Copy link

codecov bot commented Jan 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.18%. Comparing base (31410a9) to head (aba2d49).

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.
📢 Have feedback on the report? Share it here.

Signed-off-by: merobi-hub <merobi@gmail.com>
@merobi-hub merobi-hub changed the title static.yml in .github for publishing docs using github actions. GitHub workflow for publishing docs using GH Actions Jan 20, 2025
@merobi-hub merobi-hub requested a review from wslulciuc January 20, 2025 16:27
@wslulciuc
Copy link
Member

@merobi-hub Maybe we just remove the v2 subdirectory? http://marquezproject.github.io/marquez is already re-directed to https://marquezproject.ai. v2 was added to keep the old website up.

Signed-off-by: merobi-hub <merobi@gmail.com>
@boring-cyborg boring-cyborg bot added the docs label Jan 20, 2025
@merobi-hub merobi-hub changed the title GitHub workflow for publishing docs using GH Actions Promote v2 content in docs for deploying with GH Pages Jan 20, 2025
Signed-off-by: merobi-hub <merobi@gmail.com>
Copy link
Member

@wslulciuc wslulciuc left a 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! 👍

@wslulciuc wslulciuc merged commit c3af853 into main Jan 20, 2025
5 of 13 checks passed
@wslulciuc wslulciuc deleted the docs/set-up-gh branch January 20, 2025 20:34
jonathanpmoraes pushed a commit to nubank/NuMarquez that referenced this pull request Feb 4, 2025
…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>
jonathanpmoraes pushed a commit to nubank/NuMarquez that referenced this pull request Feb 6, 2025
…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>
jonathanpmoraes pushed a commit to nubank/NuMarquez that referenced this pull request Feb 6, 2025
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] New hosting solution needed
2 participants