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

Change rtfd to readthedocs #5871

Merged
merged 1 commit into from
Jul 3, 2019

Conversation

pranay414
Copy link
Contributor

This will fix issue: #5870

Copy link
Member

@stsewd stsewd left a comment

Choose a reason for hiding this comment

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

Thanks, there are places that have rtfd.org, those shouldn't be replaced. And please don't commit the PO files.

@@ -20,10 +20,10 @@ The reasoning behind this is that RTD organizes the URLs for docs so that multip

Among all the multiple versions of docs, you can choose which is the "default" version for RTD to display, which usually corresponds to the git branch of the most recent official release from your project.

rtfd.org
readthedocs.org
Copy link
Member

Choose a reason for hiding this comment

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

This shouldn't be updated

Copy link
Contributor Author

@pranay414 pranay414 Jul 2, 2019

Choose a reason for hiding this comment

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

What are PO files here? We can add them to .gitignore right?

Copy link
Member

Choose a reason for hiding this comment

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

These https://github.com/readthedocs/readthedocs.org/pull/5871/files#diff-416b5b299618cc307035d37fc0899f2e

And, not, those should live in repo, but not modified in this PR

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@stsewd I've made the changes, can you check now?

docs/contribute.rst Outdated Show resolved Hide resolved
@pranay414 pranay414 force-pushed the update-rtfd-to-readthedocs branch from 289df4d to 7b47af4 Compare July 2, 2019 04:09
Copy link
Member

@stsewd stsewd left a comment

Choose a reason for hiding this comment

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

All files from docs/locale (where the .po files should be excluded from the PR), and you shouldn't rename the classes from the css files.

@@ -23,7 +23,7 @@ Among all the multiple versions of docs, you can choose which is the "default" v
rtfd.org
~~~~~~~~

Links to rtfd.org are treated the same way as above.
Links to readthedocs.org are treated the same way as above.
Copy link
Member

Choose a reason for hiding this comment

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

This shouldn't be changed

@@ -117,7 +117,7 @@ An example nginx configuration for pip would look like:
}
}

rtfd.org
readthedocs.org
Copy link
Member

Choose a reason for hiding this comment

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

this should remain unchanged

docs/custom_domains.rst Outdated Show resolved Hide resolved
@pranay414
Copy link
Contributor Author

@stsewd can you list down what all needs to be changed? The issue description seems vague to me.

@stsewd
Copy link
Member

stsewd commented Jul 2, 2019

You should revert the changes in all .po files, and also revert the changes on domain names (rtfd.org)

@pranay414 pranay414 force-pushed the update-rtfd-to-readthedocs branch from 7b47af4 to c0097df Compare July 3, 2019 05:29
@pranay414
Copy link
Contributor Author

@stsewd I've made the required changes. Please review.

Copy link
Member

@dojutsu-user dojutsu-user left a comment

Choose a reason for hiding this comment

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

Thanks @pranay414 🎉 🎉
This looks good to me. 👍 💯

@dojutsu-user dojutsu-user requested review from saadmk11 and stsewd July 3, 2019 17:04
Copy link
Member

@saadmk11 saadmk11 left a comment

Choose a reason for hiding this comment

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

Looks Good. Thanks for your contribution 💯

@stsewd stsewd merged commit c91b332 into readthedocs:master Jul 3, 2019
@pranay414 pranay414 deleted the update-rtfd-to-readthedocs branch July 3, 2019 19:07
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.

4 participants