Skip to content

Documentation: SEO issues #9539

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 17 commits into from
Jul 23, 2025
Merged

Documentation: SEO issues #9539

merged 17 commits into from
Jul 23, 2025

Conversation

paveltovchigrechko
Copy link
Contributor

@paveltovchigrechko paveltovchigrechko commented Jun 17, 2025

Motivation and context

This PR addresses 2 issues with the documentation website (provided by audit team):

  • updates robots.txt with content
User-agent: *
Allow: /docs/
Disallow: /v*/docs/
Sitemap: {{ absURL "sitemap.xml" }}
  • updates sitemap: now instead of relative URLs it should contain absolute paths

How has this been tested?

  1. Start local server with --baseURL="docs.cvat.ai"
  2. Open localhost:1313/robots.txt
  3. Open localhost:1313/sitemap.xml

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

@paveltovchigrechko paveltovchigrechko marked this pull request as ready for review June 24, 2025 06:41
@SpecLad
Copy link
Contributor

SpecLad commented Jul 23, 2025

This looks good to me, but I found some links in the old versions of the documentation that don't work correctly (they point to the current version instead). This is because they link directly to /docs/... URLs. Here are all such links that I found:

$ rg '[^\w"]/docs/' site/content/ --sort=path
site/content/en/docs/_index.md
25:{{% blocks/feature icon="fa-sign-in-alt" title="[Getting started](/docs/getting_started/)" %}}
31:{{% blocks/feature icon="fa-question" title="[FAQ](/docs/faq/)" %}}
46:{{% blocks/feature icon="fa-book" title="[Manual](/docs/manual/)" %}}
52:{{% blocks/feature icon="fa-server" title="[Administration](/docs/administration/)" %}}
58:{{% blocks/feature icon="fa-terminal" title="[Contributing](/docs/contributing/)" %}}

site/content/en/docs/enterprise/sso.md
275:If CVAT is configured to require [email verification](/docs/administration/basics/installation/#email-verification),

site/content/en/docs/getting_started/workflow-org.md
42:   **Multitask**](/docs/manual/basics/create-multi-tasks/).

site/content/en/docs/manual/advanced/analytics-and-monitoring/auto-qa.md
123:  see [Job API create()](/docs/api_sdk/sdk/reference/apis/jobs-api/#create).

site/content/en/docs/manual/advanced/filter.md
160:[state]: /docs/manual/basics/vocabulary/#state
161:[stage]: /docs/manual/basics/vocabulary/#stage
162:[subset]: /docs/manual/basics/vocabulary/#subset
163:[resource]: /docs/manual/basics/vocabulary/#resource
164:[credentials]: /docs/manual/basics/vocabulary/#credentials
165:[mode]: /docs/manual/basics/vocabulary/#mode
166:[dimension]: /docs/manual/basics/vocabulary/#dimension

site/content/en/docs/manual/advanced/projects.md
95:[create-filter]: /docs/manual/advanced/filter/#create-a-filter
96:[operators]: /docs/manual/advanced/filter/#supported-operators-for-properties
97:[groups]: /docs/manual/advanced/filter/#groups
98:[data-and-time]: /docs/manual/advanced/filter#date-and-time-selection
99:[sorting]: /docs/manual/advanced/filter/#sort-by
100:[quick-filters]: /docs/manual/advanced/filter/#quick-filters

site/content/en/docs/manual/advanced/serverless-tutorial.md
978:[cvat-auto-annotation-guide]: /docs/administration/advanced/installation_automatic_annotation
979:[cvat-installation-guide-windows-10]: /docs/administration/basics/installation/#windows-10
980:[cvat-installation-guide-ubuntu-1804]: /docs/administration/basics/installation/#ubuntu-1804-x86_64amd64
984:[cvat-ai-tools-user-guide]: /docs/manual/advanced/ai-tools/
989:[cvat-auto-annotation-user-guide]: /docs/manual/advanced/automatic-annotation/

site/content/en/docs/manual/basics/cloud-storages.md
54:[create-filter]: /docs/manual/advanced/filter/#create-a-filter
55:[operators]: /docs/manual/advanced/filter/#supported-operators-for-properties
56:[groups]: /docs/manual/advanced/filter/#groups
57:[data-and-time]: /docs/manual/advanced/filter#date-and-time-selection
58:[sorting]: /docs/manual/advanced/filter/#sort-by
59:[quick-filters]: /docs/manual/advanced/filter/#quick-filters

site/content/en/docs/manual/basics/jobs-page.md
55:[state]: /docs/manual/basics/vocabulary/#state
56:[stage]: /docs/manual/basics/vocabulary/#stage
57:[create-task]: /docs/manual/basics/create-annotation-task
58:[create-filter]: /docs/manual/advanced/filter/#create-a-filter
59:[operators]: /docs/manual/advanced/filter/#supported-operators-for-properties
60:[groups]: /docs/manual/advanced/filter/#groups
61:[data-and-time]: /docs/manual/advanced/filter#date-and-time-selection
62:[sorting]: /docs/manual/advanced/filter/#sort-by
63:[quick-filters]: /docs/manual/advanced/filter/#quick-filters

site/content/en/docs/manual/basics/tasks-page.md
64:[create-filter]: /docs/manual/advanced/filter/#create-a-filter
65:[operators]: /docs/manual/advanced/filter/#supported-operators-for-properties
66:[groups]: /docs/manual/advanced/filter/#groups
67:[data-and-time]: /docs/manual/advanced/filter#date-and-time-selection
68:[sorting]: /docs/manual/advanced/filter/#sort-by
69:[quick-filters]: /docs/manual/advanced/filter/#quick-filters
70:[subset]: /docs/manual/basics/vocabulary/#subset

Could you replace these with ilink? It won't fix the problem for existing releases, but it will stop it for any future releases going forward.

In _index.md you won't be able to use ilink (shortcodes don't work inside another shortcode's parameters), so just remove the /docs/ prefix so that the link is relative to the page.

@paveltovchigrechko
Copy link
Contributor Author

I changed the links, please, check @SpecLad

Copy link

@SpecLad SpecLad merged commit d9abfe9 into develop Jul 23, 2025
55 of 60 checks passed
@SpecLad SpecLad deleted the pt/docs-seo-issues branch July 23, 2025 15:31
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.

2 participants