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

New Docs Site #2620

Merged
merged 31 commits into from
Oct 3, 2023
Merged

New Docs Site #2620

merged 31 commits into from
Oct 3, 2023

Conversation

phixMe
Copy link
Member

@phixMe phixMe commented Sep 22, 2023

Problem

We would like to unify our docs site on a single domain with our blog posts, quickstart and api documentation.

Preview:
image

image

For now

  • Migrate existing layout into new renderer.
  • Generate mdx templates from docs
  • Migrate Quickstart
  • Update Social Links
  • Migrate Blogs

For Later

Full text search indexing via Algolia
Full CI workflow to facilitate automated releases
Automatic openapi.yml workflow and generation

One-line summary:
Unified docs experience under a single roof powered by Docusaurus.

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)

@boring-cyborg boring-cyborg bot added the docs label Sep 22, 2023
@codecov
Copy link

codecov bot commented Sep 22, 2023

Codecov Report

Merging #2620 (05d7e6c) into main (01ed782) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main    #2620   +/-   ##
=========================================
  Coverage     83.35%   83.35%           
  Complexity     1295     1295           
=========================================
  Files           244      244           
  Lines          5948     5948           
  Branches        279      279           
=========================================
  Hits           4958     4958           
  Misses          844      844           
  Partials        146      146           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@phixMe phixMe marked this pull request as ready for review September 25, 2023 20:08
@phixMe phixMe changed the title WIP - New Docs Site New Docs Site Sep 25, 2023
@merobi-hub
Copy link
Collaborator

Screenshot 2023-09-26 at 17 36 25

Signed-off-by: Michael Robinson <[email protected]>
@netlify
Copy link

netlify bot commented Oct 2, 2023

Deploy Preview for peppy-sprite-186812 ready!

Name Link
🔨 Latest commit 05d7e6c
🔍 Latest deploy log https://app.netlify.com/sites/peppy-sprite-186812/deploys/651c8e3407c4e300080ae67d
😎 Deploy Preview https://deploy-preview-2620--peppy-sprite-186812.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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 site looks sweet! 💯 💯 💯

Before we merge, I would move the website code to docs/v2. That way, we can iterate on the new website without impacting the current (v1) site.

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.

❤️

@wslulciuc wslulciuc merged commit 75da43c into main Oct 3, 2023
6 checks passed
@wslulciuc wslulciuc deleted the docs/v2 branch October 3, 2023 22:19
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.

3 participants