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

Guide: deprecating content #7333

Merged
merged 3 commits into from Aug 26, 2020
Merged

Guide: deprecating content #7333

merged 3 commits into from Aug 26, 2020

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Jul 29, 2020

Copy link
Member

@humitos humitos left a comment

Looks like a good start.

We could mentioned .. deprecated:: directive and others as well, like .. versionchanged:: and .. versionadded::

docs/guides/deprecating-content.rst Outdated Show resolved Hide resolved
docs/guides/deprecating-content.rst Outdated Show resolved Hide resolved
docs/guides/deprecating-content.rst Outdated Show resolved Hide resolved

User-agent: *

Disallow: /en/latest/api/v1.html # Deprecated API
Copy link
Member

@humitos humitos Jul 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes me think that our search rank system may take a look at robots.txt file and mark these entries with lower ranking in our index automatically. This guide makes it clear that you have to do the same in two different places: one for Search Engines and the same for Read the Docs search engine.

.. code-block:: yaml

# .readthedocs.yaml

version: 2
search:
ranking:
api/v1.html: -1
Copy link
Member

@humitos humitos Jul 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here with the robots.txt and yaml from this section. I'd say it's enough by mentioning it and pointing to the search.ranking config. That way, we keep this documentation in only one place. Users can just hover over the :ref: and immediately see how the config file looks like.

Copy link
Member Author

@stsewd stsewd Jul 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, this shows how to use the feature with the current example, and it's easy to copy/paste.

stsewd and others added 2 commits Jul 29, 2020
@stsewd stsewd merged commit 0858709 into master Aug 26, 2020
2 checks passed
@stsewd stsewd deleted the guide-deprecate-content branch Aug 26, 2020
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.

None yet

2 participants