FAQ | This is a LIVE service | Changelog

Skip to content

Prevent search engines from indexing non-prod envs

As a DevOps Engineer, 
I would like to ensure that non-production environments are not indexed by search engines 
to prevent exposure of non-prod data and avoid confusion in search results.

Background

The current issue arises because search engines are indexing non-production environments linked from pages such as Job Opportunities. An example search result can be seen here, which includes non-prod job opportunities. A known case involving the use of nofollow links (#1557) in mkdocs to prevent indexing has been identified. Mkdocs, however, doesn't natively support nofollow links in Markdown.

The proposed solution involves updating mkdocs to add the attr_list extension, which allows for the inclusion of rel="nofollow" attributes in links to non-prod environments.

Acceptance Criteria

  • Update mkdocs configuration to include the attr_list extension as per attr_list extension documentation.
  • Ensure links to non-prod environments include the rel="nofollow" attribute.
  • Document the process of adding nofollow attributes in the project's markdown documentation guidelines.
Edited by E. Evstafiev