Skip to content

Migrate docs to Meilisearch subdomain #810

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

Merged
merged 2 commits into from
Jul 24, 2023
Merged

Migrate docs to Meilisearch subdomain #810

merged 2 commits into from
Jul 24, 2023

Conversation

Strift
Copy link
Contributor

@Strift Strift commented Jul 24, 2023

Pull Request

The goal of this PR is to prepare the repository to have the docs migrated to https://python-sdk.meilisearch.com.

What does this PR do?

  • Inject the Fathom analytics script
  • Add CNAME for Github Pages redirection (see github docs)

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

@Strift Strift changed the title Inject Fathom script in docs Migrate docs to Meilisearch subdomain Jul 24, 2023
@Strift
Copy link
Contributor Author

Strift commented Jul 24, 2023

I realize my initial description of the issue was a bit light. I updated it.

Copy link
Collaborator

@sanders41 sanders41 left a comment

Choose a reason for hiding this comment

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

LGTM

The goal of this PR is to prepare the repository to have the docs migrated to https://python-sdk.meilisearch.com

Does preparing mean you want to hold this for now or merge?

@@ -0,0 +1 @@
python-sdk.meilisearch.com/
Copy link
Collaborator

Choose a reason for hiding this comment

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

One thing I just though of, wouldn't the CNAME file go in the docs folder instead of the root directory?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From my understanding of the Github docs, it should be at the root of the repository.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm an no expert here, but I think that assumes the purpose of the repo is for docs only. You can see how I have it setup here and working https://github.com/sanders41/meilisearch-python-async/tree/main/docs. Though like I said I'm not an expert so maybe my setup works, but isn't correct.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'll go ahead and merge. The worst thing I can think that would happen is the CNAME doesn't get picked up and then we just need a new PR to move the file.

@Strift
Copy link
Contributor Author

Strift commented Jul 24, 2023

No reason to hold this for now. The changes shouldn't have any effect until we update DNS configuration for the Meilisearch domain. But I can't guarantee when this will be done (although today or in the coming days is likely.)

When that is effective, I will make another small PR to update the links to the SDK docs in the README. The current docs URL will still be working so it's OK if we're not 100% synchronous on this.

If it all looks good to you, I'm happy to merge this.

Thanks for your help!

@bwklein
Copy link

bwklein commented Jul 24, 2023

@Strift looks like the redirect is happening, but I am getting an error that the site can't be reached at the new subdomain.
https://meilisearch.github.io/meilisearch-python/ -> https://python-sdk.meilisearch.com/

@sanders41
Copy link
Collaborator

sanders41 commented Jul 24, 2023

@bwklein you are right, but this is weird because the PR hasn't been merged. I'm not sure why it is already redirecting already. @Strift any ideas? Change is the pages settings I assume?

@sanders41
Copy link
Collaborator

Ok I found it. The pages settings have been updated. @bwklein if you have any specific questions while this gets sorted out and want to ask in either an issue on on Discord I'll do my best to help.

@bwklein
Copy link

bwklein commented Jul 24, 2023

Ok I found it. The pages settings have been updated. @bwklein if you have any specific questions while this gets sorted out and want to ask in either an issue on on Discord I'll do my best to help.

I'll find you on Discord. We updated some things and now we are getting an unexpected error through the Python SDK.
I was looking for docs to see what changed.

@sanders41
Copy link
Collaborator

bors merge

@meili-bors
Copy link
Contributor

meili-bors bot commented Jul 24, 2023

Build succeeded:

@meili-bors meili-bors bot merged commit abd1c51 into main Jul 24, 2023
@meili-bors meili-bors bot deleted the migrate-docs branch July 24, 2023 21:11
@Strift
Copy link
Contributor Author

Strift commented Jul 25, 2023

@sanders41 I'm not sure really. Seems weird that the changes to Pages settings would result in this downtime. It didn't happen when we did the same change on meilisearch-php repository.

I asked @alallema @tpayet to help me check if it could be due to DNS settings, as I don't have access.

@sanders41 sanders41 added the skip-changelog The PR will not appear in the release changelogs label Jul 25, 2023
meili-bors bot added a commit that referenced this pull request Jul 31, 2023
815: Update version for the next release (v0.28.2) r=sanders41 a=meili-bot

This version introduces features released on Meilisearch v1.3.0 🎉
Check out the changelog of [Meilisearch v1.3.0](https://github.com/meilisearch/meilisearch/releases/tag/v1.3.0) for more information on the changes. 

⚠️ If you want to adopt new features of this release, **update the Meilisearch server** to the according version.

## 🚀 Enhancements

* ⚠️ **EXPERIMENTAL**: Adds docstring and tests for vector search (#805) `@sanders41` 

⚠️ The EXPERIMENTAL features are not covered by semver. To explicitly opt-in, check this [guide](https://www.meilisearch.com/docs/reference/api/experimental-features).

## 🐛 Bug Fixes

* Fix potential json_encoding date error and truncation in pydantic < 2 (#807) `@sanders41`

## 💅 Misc

* Migrate docs hosting to Meilisearch subdomain (#810) `@Strift`
* Update documentation deployment workflow (#811) `@Strift` 

Thanks again to `@Strift,` `@alallema,` and `@sanders41!` 🎉

Co-authored-by: meili-bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants