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

[RFC] Remove glossary #5462

Closed
wouterj opened this issue Jun 28, 2015 · 6 comments
Closed

[RFC] Remove glossary #5462

wouterj opened this issue Jun 28, 2015 · 6 comments
Labels
hasPR A Pull Request has already been submitted for this issue. Waiting feedback

Comments

@wouterj
Copy link
Member

wouterj commented Jun 28, 2015

It has recieved it's last word-changing change on September 18th, 2013. The article itself doesn't seem to be linked from anywhere on symfony.com (doc index, navigation, ...). The :term: roles linking to the glossary have not been added since I'm reviewing PRs.

In other words: It hasn't recieved any love from us since I joined the docs.

I don't know about the amount of visitors (/cc @javiereguiluz), but I would like to propose the article. I think all terms are covered with just as nice (or nicer) descriptions in the related book/cookbook pages, meaning people are directly on the good page to read more about the topic.

/cc @xabbuh @weaverryan

@xabbuh
Copy link
Member

xabbuh commented Jun 28, 2015

Just in case someone is wondering what this is all about: The glossary can be seen at http://symfony.com/doc/current/glossary.html.

@xabbuh
Copy link
Member

xabbuh commented Jun 28, 2015

Oh, I just found where it is linked: http://symfony.com/doc/current/genindex.html (if a term is used in the glossary)

@xabbuh
Copy link
Member

xabbuh commented Jun 28, 2015

Anyway, as a last comment in this row. ;) Unless Javier reveals that there are a lot of people visiting the glossary, I will be absolutely 👍 to remove it. It's completely outdated and didn't receive any love.

@weaverryan
Copy link
Member

Let's remove it. When I first started with RST, I thought it was a neat idea, but I don't think anyone is using it - the fact that there have been probably zero pull requests to this section shows how many people are using it.

@javiereguiluz
Copy link
Member

During the last 12 months, the Glossary page has been the 230th most popular doc page. Its traffic is marginal, so I think it's safe to remove it.

@xabbuh
Copy link
Member

xabbuh commented Jun 29, 2015

@javiereguiluz Thanks, do we need to wait for you to remove references to it on the web site first to not break the build process?

@wouterj wouterj added the hasPR A Pull Request has already been submitted for this issue. label Jun 29, 2015
wouterj added a commit to wouterj/symfony-docs that referenced this issue 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 as completed Jul 8, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hasPR A Pull Request has already been submitted for this issue. Waiting feedback
Projects
None yet
Development

No branches or pull requests

4 participants