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.

Sign up for GitHub

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

Jump to bottom

Update information and links of documentation #7385

Merged
merged 6 commits into from
Jan 17, 2019
Merged

Update information and links of documentation #7385

merged 6 commits into from
Jan 17, 2019

Conversation

SenseException
Copy link
Member

Some of the links in the documentation were outdated, 404 or just didn't work. A few external links led to deprecated pages too. I created this PR to update some links and outdated info content for the current version. This needs to be put into the newer, upcoming versions too.

It also looks like that :ref: reStructuredText aren't handled properly, because a few lead to the same page instead to the set label. This is not part of this PR though and needs to be fixed on the website's doc-generation.

@jwage
Copy link
Member

jwage commented Sep 3, 2018

Can you create an issue with some example refs that aren't working? I will investigate.

@SenseException
Copy link
Member Author

SenseException commented Sep 6, 2018 •
edited
Loading

This would be a change for doctrine website, that creates the documentation out of the reStructuredText files. Maybe I take a look into it myself, but for now I want to keep the documentation itself with PRs like this one up to date.

@SenseException SenseException mentioned this pull request Sep 6, 2018
Closed
@jwage
Copy link
Member

jwage commented Sep 10, 2018

I refactored doctrine/rst-parser and fixed a few issues with reference resolving. I think it should take care of the issues noted above.

@SenseException
Copy link
Member Author

This PR still needs to get merged to the version branches or get further reviews to improve the documentation.

@SenseException
Copy link
Member Author

ping

Majkl578
Majkl578 previously requested changes Nov 11, 2018
View reviewed changes
Copy link
Contributor

@Majkl578 Majkl578 left a comment

Choose a reason for hiding this comment

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

👍 overall

docs/en/cookbook/advanced-field-value-conversion-using-custom-mapping-types.rst Outdated Show resolved Hide resolved
docs/en/cookbook/dql-user-defined-functions.rst Outdated Show resolved Hide resolved
docs/en/reference/configuration.rst Outdated Show resolved Hide resolved
docs/en/reference/configuration.rst Outdated Show resolved Hide resolved
docs/en/reference/installation.rst Show resolved Hide resolved
docs/en/tutorials/getting-started.rst Outdated Show resolved Hide resolved
@Majkl578
Copy link
Contributor

Rebase will be needed since #7421 landed.

@SenseException
Copy link
Member Author

Rebase done.

jwage
jwage previously approved these changes Nov 14, 2018
View reviewed changes
@SenseException
Copy link
Member Author

Are any further changes needed?
How do we add those changes to master after this is merged into 2.6?

@SenseException SenseException mentioned this pull request Jan 5, 2019
Closed
@jwage
Copy link
Member

jwage commented Jan 5, 2019

I think we would merge this to master and then cherry pick to lower branches?

@Majkl578
Copy link
Contributor

Majkl578 commented Jan 5, 2019

Rebase is needed.
Leave this targetting 2.6 and send another PR targetting master. Thanks.

@SenseException
Copy link
Member Author

Rebase is done. I'll create a PR to master after this one got merged.

@Ocramius Ocramius self-assigned this Jan 17, 2019
Ocramius
Ocramius approved these changes Jan 17, 2019
View reviewed changes
Copy link
Member

@Ocramius Ocramius left a comment

Choose a reason for hiding this comment

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

🚢 Sorry for not noticing this before!

@Ocramius Ocramius dismissed Majkl578’s stale review January 17, 2019 20:11

Changes were already handled by author

@Ocramius Ocramius merged commit 536e31f into doctrine:2.6 Jan 17, 2019
This was referenced Jan 22, 2019
Merged
Merged
@SenseException SenseException deleted the links-and-typos branch January 22, 2019 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Majkl578 Majkl578 Majkl578 left review comments

@Ocramius Ocramius Ocramius approved these changes

@jwage jwage jwage left review comments

Assignees

@Ocramius Ocramius

Labels
Documentation Improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@SenseException @jwage @Majkl578 @Ocramius