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

Use forked mkdocs-redirects #2404

Merged
merged 3 commits into from
Jun 13, 2023
Merged

Use forked mkdocs-redirects #2404

merged 3 commits into from
Jun 13, 2023

Conversation

jprochazk
Copy link
Member

@jprochazk jprochazk commented Jun 13, 2023

What

Fix for #2222 (round 2)

Related commit - it's just removing the noindex line from the redirect index.html template. I have yet to confirm if this actually has the intended effect, but it's the only noindex anywhere in the entire docs site, and that's what google search console was complaining about. If this works, I'll make a PR upstream with the fix.

Checklist

PR Build Summary: https://build.rerun.io/pr/2404

Docs preview: https://rerun.io/preview/6383747/docs
Examples preview: https://rerun.io/preview/6383747/examples

@jprochazk jprochazk added the 📖 documentation Improvements or additions to documentation label Jun 13, 2023
rerun_py/requirements-doc.txt Outdated Show resolved Hide resolved
@jprochazk
Copy link
Member Author

Updated requirements to use git+ instead of the zip archive, because the zip archive has extremely heavy secondary rate limiting. This means a git clone of rerun-io/mkdocs-redirects is necessary for every pip install -r requirements-docs.txt, but the repo is pretty small, so it's not too bad.

@jprochazk jprochazk merged commit 0f89b62 into main Jun 13, 2023
@jprochazk jprochazk deleted the jan/remove-mkdocs-noindex branch June 13, 2023 08:22
emilk added a commit that referenced this pull request Jun 15, 2023
<!--
Open the PR up as a draft until you feel it is ready for a proper
review.

Do not make PR:s from your own `main` branch, as that makes it difficult
for reviewers to add their own fixes.

Add any improvements to the branch as new commits to make it easier for
reviewers to follow the progress. All commits will be squashed to a
single commit once the PR is merged into `main`.

Make sure you mention any issues that this PR closes in the description,
as well as any other related issues.

To get an auto-generated PR description you can put "copilot:summary" or
"copilot:walkthrough" anywhere.
-->

### What

Fix for #2222 (round 2)

[Related
commit](rerun-io/mkdocs-redirects@d367a08)
- it's just removing the `noindex` line from the redirect `index.html`
template. I have yet to confirm if this actually has the intended
effect, but it's the only `noindex` anywhere in the entire docs site,
and that's what google search console was complaining about. If this
works, I'll make a PR upstream with the fix.

### Checklist
* [ ] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [ ] I've included a screenshot or gif (if applicable)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: https://build.rerun.io/pr/2404

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/6383747/docs
Examples preview: https://rerun.io/preview/6383747/examples
<!-- pr-link-docs:end -->

---------

Co-authored-by: Emil Ernerfeldt <[email protected]>
This was referenced Jun 15, 2023
@Wumpf Wumpf added 🧑‍💻 dev experience developer experience (excluding CI) dependencies concerning crates, pip packages etc labels Jun 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies concerning crates, pip packages etc 🧑‍💻 dev experience developer experience (excluding CI) 📖 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants