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.

Sign up for GitHub

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

Jump to bottom

API not indexed by search engines #2222

Open
roym899 opened this issue May 25, 2023 · 7 comments
Open

API not indexed by search engines #2222

roym899 opened this issue May 25, 2023 · 7 comments
Assignees
@jprochazk
Labels
😤 annoying Something in the UI / SDK is annoying to use 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less

Comments

@roym899
Copy link
Collaborator

roym899 commented May 25, 2023 •
edited
Loading

Describe the annoyance
Right now it seems nearly impossible to find direct links to the Python API with google / bing / etc.

Haven't done any testing for the Rust API.

To Reproduce
Some search terms that would not come up with anything:
rerun log_image, rerun log_image python api, rerun python api, ...

Typically the docs.rerun.io pages show up, however, direct links to ref.rerun.io seem quite difficult to find.
@roym899 roym899 added 👀 needs triage This issue needs to be triaged by the Rerun team 😤 annoying Something in the UI / SDK is annoying to use labels May 25, 2023
@nikolausWest nikolausWest added 📖 documentation Improvements or additions to documentation and removed 👀 needs triage This issue needs to be triaged by the Rerun team labels May 30, 2023
@nikolausWest
Copy link
Member

@jprochazk: this might be something to look into while you look at #2263

@jprochazk jprochazk mentioned this issue Jun 7, 2023
Merged
1 task
Wumpf pushed a commit that referenced this issue Jun 8, 2023
@jprochazk
Add site_url to mkdocs.yml (#2326)
0fee672 
<!--
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 (maybe)

It seems like the sitemap for `ref.rerun.io/docs/python/...` is empty.
It can be fixed by adding a `site_url` for it to use as the base url of
links in the sitemap.

### Checklist
* [x] 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)

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

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/edb65d4/docs
Examples preview: https://rerun.io/preview/edb65d4/examples
<!-- pr-link-docs:end -->
@jprochazk
Copy link
Member

ref.rerun.io needs a redeploy after #2326

@emilk emilk added the 🏎️ Quick Issue Can be fixed in a few hours or less label Jun 12, 2023
@jprochazk jprochazk mentioned this issue Jun 13, 2023
Merged
2 tasks
jprochazk added a commit that referenced this issue Jun 13, 2023
@jprochazk @emilk
Use forked mkdocs-redirects (#2404)
0f89b62 
<!--
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]>
@jprochazk
Copy link
Member

Seems like #2404 helped, as Google now reports that the live URL is indexable. We're just waiting on it to actually crawl and index the pages now.
image

emilk pushed a commit that referenced this issue Jun 15, 2023
@jprochazk @emilk
Add site_url to mkdocs.yml (#2326)
db6a5ee 
<!--
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 (maybe)

It seems like the sitemap for `ref.rerun.io/docs/python/...` is empty.
It can be fixed by adding a `site_url` for it to use as the base url of
links in the sitemap.

### Checklist
* [x] 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)

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

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/edb65d4/docs
Examples preview: https://rerun.io/preview/edb65d4/examples
<!-- pr-link-docs:end -->
emilk added a commit that referenced this issue Jun 15, 2023
@jprochazk @emilk
Use forked mkdocs-redirects (#2404)
7927d15 
<!--
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]>
@emilk
Copy link
Member

emilk commented Jul 7, 2023

googling "site:ref.rerun.io" is now giveing nine hits! So some progress :)

@emilk
Copy link
Member

emilk commented Jul 10, 2023

googling site:ref.rerun.io is now giving 129 hits, so things are progressing quickly

@Wumpf
Copy link
Member

Wumpf commented Jul 18, 2023

I'm only seeing 8 now 🤔

@roym899
Copy link
Collaborator Author

roym899 commented Jul 18, 2023 •
edited
Loading

I wonder if since there are no separate pages for each function, it might actually be impossible to find direct links to functions? Quick search seems to suggest that anchor links aren't indexed separately.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jprochazk jprochazk

Labels
😤 annoying Something in the UI / SDK is annoying to use 📖 documentation Improvements or additions to documentation 🏎️ Quick Issue Can be fixed in a few hours or less
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@emilk @Wumpf @jprochazk @nikolausWest @roym899