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

Move guides to new section #2830

Merged
merged 47 commits into from
Jun 6, 2024
Merged

Move guides to new section #2830

merged 47 commits into from
Jun 6, 2024

Conversation

Strift
Copy link
Contributor

@Strift Strift commented May 22, 2024

Why

Move cookbooks, deployment, and front-end pages from Learn to Guides top-level section.

How

  • Move MDX files to the guides folder
  • Update the sidebar-config.json configuration file
  • Update links in existing pages
  • Update redirects.json to exhaustively list all updated URLs
  • Update link checker script to test against sidebar-config.json configuration too

⚠️ Checks are currently failing for all guides/* URLs

Deployment

This PR needs to be merged before the website's PR that enables the guides section.

This will allow us to get the following deployment process:

  1. The website will trigger a deployment: the content moved to Guides will be temporarily inaccessible (but the site won't break)
  2. Merge the website PR to trigger a deployment: the Guides section will be activated and its content will be activated

@Strift Strift requested a review from CaroFG as a code owner May 22, 2024 15:40
@meili-bot
Copy link
Collaborator

How to see the preview of this PR?

⚠️ Private link, only accessible to Meilisearch employees.

Go to this URL: https://website-git-deploy-preview-mei-16-meili.vercel.app/docs/branch:add-guides-section

Credentials to access the page are in the company's password manager as "Docs deploy preview".

@CaroFG
Copy link
Contributor

CaroFG commented May 23, 2024

Hey, am I supposed to be able to see the Guides section in the preview? Because it does not appear

@guimachiavelli
Copy link
Member

If this is purely a draft and not yet intended to be merged, can I convert it to a draft PR?

@Strift Strift marked this pull request as draft May 23, 2024 10:33
@Strift
Copy link
Contributor Author

Strift commented May 23, 2024

@guimachiavelli Apologies, I converted it to a draft PR ✅


@CaroFG Link preview doesn't work, because this requires toggling something in website repository (see related changes)

You can preview changes with this link: https://website-git-feat-enable-docs-guides-meili.vercel.app/docs

@CaroFG
Copy link
Contributor

CaroFG commented May 23, 2024

Ok, LGTM but at some point we will need to consider organizing the guides by themes into subsections

@Strift Strift changed the title Draft - Add guides section Add guides section May 27, 2024
@Strift Strift changed the title Add guides section Move guides to new section May 28, 2024
config/redirects.json Outdated Show resolved Hide resolved
Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two main things:

  1. I'm a bit concerned about the added line to the workflow file. Wouldn't want to mess up our already frail pipeline. I'm terrible with GH actions and etc, so do ping clémentine if you need help assessing this
  2. The broken links action is failing. Might be related to the previous item

The rest is fairly minor, mostly due diligence

.github/workflows/validate-docs-links.yml Outdated Show resolved Hide resolved
.github/actions/validate-docs-links/src/checker.ts Outdated Show resolved Hide resolved
.github/actions/validate-docs-links/src/checker.ts Outdated Show resolved Hide resolved
.github/actions/validate-docs-links/src/checker.ts Outdated Show resolved Hide resolved
guides/front_end/pagination.mdx Outdated Show resolved Hide resolved
@Strift
Copy link
Contributor Author

Strift commented May 29, 2024

Thanks for the reviews.

@guimachiavelli I think the action is failing because GitHub is running the action code that is on the main branch. If you take a look, you can see that only the links to /guides URLs are failing.

That's because this PR also contains the relevant changes in the GitHub action to validate links to guides.

It's a bit more work, but if you prefer, I can move those changes to another PR, so we can:

  1. Merge the PR that updates the action
  2. Relaunch CI for this PR with the updated action

What do you think?

@Strift
Copy link
Contributor Author

Strift commented Jun 4, 2024

I moved the changes related to CI in #2841.

If we merge that one first, the CI will pass on this PR.

CaroFG
CaroFG previously approved these changes Jun 4, 2024
Copy link
Contributor

@CaroFG CaroFG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@guimachiavelli guimachiavelli merged commit c7d29b4 into main Jun 6, 2024
1 check passed
@guimachiavelli guimachiavelli deleted the add-guides-section branch June 6, 2024 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants