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

Removed the glossary #5464

Closed
wants to merge 1 commit into from
Closed

Removed the glossary #5464

wants to merge 1 commit into from

Conversation

wouterj
Copy link
Member

@wouterj wouterj commented Jun 29, 2015

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets #5462

It's funny that 99% of the :term: usages were located in sentences describing a term. So we didn't loose any information there. In some cases, I've tweaked the sentence a bit not loose any important information.

As for the genindex mentioned by @xabbuh in the issue, I believe this one is created automatically by Sphinx based on all .. index:: directives in the documentation. When removing the glossary, the genindex will automatically not include the terms anymore (/cc @javiereguiluz please confirm).

@xabbuh
Copy link
Member

xabbuh commented Jun 29, 2015

@wouterj I am more concerned about the link to the glossary in the navigation. Would be bad if a link led to a non-existing page.

@weaverryan
Copy link
Member

👍, but only after Javier is able to remove the Glosaary link on http://symfony.com/doc/current/index.html

@wouterj
Copy link
Member Author

wouterj commented Jun 29, 2015

Ah, missed that link. Indeed, we should wait until the link is removed from the index

@xabbuh xabbuh added the On hold label Jun 29, 2015
@wouterj
Copy link
Member Author

wouterj commented Jul 21, 2015

ping @javiereguiluz Did you already create a PR to remove the glossary link?

@wouterj
Copy link
Member Author

wouterj commented Aug 22, 2015

I'm sorry to bother you again, @javiereguiluz, but what is the status of this?

@xabbuh
Copy link
Member

xabbuh commented Oct 5, 2015

ping @javiereguiluz :)

@TomasVotruba
Copy link

👍

Ping @javiereguiluz - only this needs to be done here: #5464 (comment)

@xabbuh xabbuh added the Website label May 21, 2016
@javiereguiluz
Copy link
Member

The glossary has now been unlinked from the Symfony Docs index (it will be public after the next deployment).

@wouterj
Copy link
Member Author

wouterj commented Jul 8, 2016

Thanks @javiereguiluz! I've rebased this PR, it's ready to merge once symfony.com is redeployed.

status: reviewed

wouterj added a commit to wouterj/symfony-docs that referenced this pull request Jul 8, 2016
This PR was submitted for the 2.3 branch but it was merged into the 2.7 branch instead (closes symfony#5464).

Discussion
----------

Removed the glossary

| Q | A
| --- | ---
| Doc fix? | yes
| New docs? | no
| Applies to | all
| Fixed tickets | symfony#5462

It's funny that 99% of the `:term:` usages were located in sentences describing a term. So we didn't loose any information there. In some cases, I've tweaked the sentence a bit not loose any important information.

As for the genindex mentioned by @xabbuh in the issue, I believe this one is created automatically by Sphinx based on all `.. index::` directives in the documentation. When removing the glossary, the genindex will automatically not include the terms anymore (/cc @javiereguiluz please confirm).

Commits
-------

1c05aad Removed the glossary
@wouterj wouterj closed this Jul 8, 2016
@wouterj wouterj deleted the issue_5462 branch July 8, 2016 10:38
@TomasVotruba
Copy link

@wouterj Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants