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

doc overhaul step 1: simplify index and group deprecated files #2097

Merged
merged 8 commits into from May 10, 2020
Merged

doc overhaul step 1: simplify index and group deprecated files #2097

merged 8 commits into from May 10, 2020

Conversation

alvyjudy
Copy link
Contributor

@alvyjudy alvyjudy commented May 10, 2020

This is the first step on #2093 . Quite a few links might be broken for the time being but I would like to make sure I'm on the right track before moving forward

Summary of changes

  1. simplified top index into three entires: user guide, development guide, and deprecated (depth is now 1, before I can clean up the entries for sub index)
  2. renamed doc for python eggs (formats.txt --> python_egg.txt)
  3. move python_eggs, easy_intall, python2to3 docs into dedicated folder (deprecated)
  4. create index inside "deprecated" folder and reference it in the top index

Pull Request Checklist

  • Changes have tests
  • News fragment added in changelog.d.

@alvyjudy
Copy link
Contributor Author

alvyjudy commented May 10, 2020

If possible, I would like to have this PR merged into a separate branch rather than master because it is an ongoing process and might (and already) break some links until it's completed:)

@jaraco jaraco changed the base branch from master to feature/2093-docs-revamp May 10, 2020
@jaraco jaraco merged commit d2fe061 into pypa:feature/2093-docs-revamp May 10, 2020
2 of 3 checks passed
@alvyjudy alvyjudy deleted the improve-doc branch May 10, 2020
development
roadmap
Deprecated: Easy Install <easy_install>
history
Copy link
Member

@webknjaz webknjaz Oct 15, 2020

Choose a reason for hiding this comment

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

Was the removal of the changelog deliberate?

Copy link
Member

@jaraco jaraco Oct 16, 2020

Choose a reason for hiding this comment

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

No. The changelog should be retained, and it perhaps should even have a forwarding link so historical links can still reach it.

Copy link
Member

@webknjaz webknjaz Oct 16, 2020

Choose a reason for hiding this comment

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

FWIW I've sent a few recovery PRs like #2425

webknjaz added a commit to webknjaz/setuptools that referenced this pull request Oct 15, 2020
webknjaz added a commit to webknjaz/setuptools that referenced this pull request Oct 15, 2020
webknjaz added a commit to webknjaz/setuptools that referenced this pull request Oct 15, 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

3 participants