Allow the documentation website to be indexed by search engines #5623
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Our HTML documentation template slaps a `<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">` on every page unless the `HUGO_ENV` environment variable is set to `production`, thereby excluding the entire documentation website from web search results. Set the variable to fix it. This behavior is inherited from Docsy, although they have changed it since: <google/docsy#653>.
nmanovic
approved these changes
Jan 25, 2023
mikhail-treskin
pushed a commit
to retailnext/cvat
that referenced
this pull request
Jul 1, 2023
…-ai#5623) Our HTML documentation template slaps a `<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">` on every page unless the `HUGO_ENV` environment variable is set to `production`, thereby excluding the entire documentation website from web search results. Set the variable to fix it. This behavior is inherited from Docsy, although they have changed it since: <google/docsy#653>.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our HTML documentation template slaps a
<META NAME="ROBOTS" CONTENT="NOINDEX, NOFOLLOW">on every page unless theHUGO_ENVenvironment variable is set toproduction, thereby excluding the entire documentation website from web search results. Set the variable to fix it.This behavior is inherited from Docsy, although they have changed it since: google/docsy#653.
Motivation and context
I have long had trouble finding the CVAT manual via Google, and finally realized that something fishy must be going on.
How has this been tested?
I checked that setting
HUGO_ENVto production does indeed removeNOINDEX, NOFOLLOWfrom the generated pages.Checklist
developbranch[ ] I have added a description of my changes into CHANGELOG file[ ] I have updated the documentation accordingly[ ] I have added tests to cover my changes[ ] I have linked related issues (read github docs)[ ] I have increased versions of npm packages if it is necessary (cvat-canvas,cvat-core, cvat-data and cvat-ui)
License
Feel free to contact the maintainers if that's a concern.