Skip to content

[WIP] Making consistent component names throughout the docs #3183

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

Merged
merged 2 commits into from
Nov 18, 2013
Merged

[WIP] Making consistent component names throughout the docs #3183

merged 2 commits into from
Nov 18, 2013

Conversation

bicpi
Copy link
Contributor

@bicpi bicpi commented Nov 14, 2013

Q A
Doc fix? yes
New docs? no
Applies to 2.2+
Fixed tickets -

As discussed in #3173 here's a WIP PR for making the component names consistent.

What I did throughout the whole docs:

  • Remove blanks from component names, e.g. Class Loader > ClassLoader
  • Remove literal formatting from component names, e.g. ClassLoader > ClassLoader
  • In normal text: Lowercase the word component, e.g. The ClassLoader Component* > The ClassLoader component
  • Uppercase component names where they were not, e.g. ... the console component ... > ... the Console component ...

What I did not:

  • Change something that looks like a component name but is more used for the concept behind, e.g. "The dependency injection pattern ..." or "The event dispatcher system ..."
  • Change ucfirst of "Component" in headings

Some things are tricky, however:

  1. What about the components entry page. Do the items on the top-most level refer more to the component or the concept? For example, it says "DOM Crawler" and then below "The DomCrawler" component. I've left this as is, so I read it like "Need a thing to crawl the DOM?" - then "The DomCrawler component" is made for you.
  2. What about the index? For instance, the entry "Dependency Injection": Is this more "The Dependency Injection component" or "The Dependency Injection pattern". I've also left this as is - maybe that's just too much ;-) But in any case, below the "Components" key, I've updated everything to the correct names. In contrast, however, I've updated the "Event Dispatcher" index to "EventDispatcher" because nearly everything there refers to the component and not the concept of an event dispatcher (as for the HttpFoundation index etc.)

Please let me know if you have any suggestions.

@weaverryan
Copy link
Member

Hey Philipp!

I agree with what you've listed here. On the components entry page, I think that "DOM Crawler" should be "DomCrawler" - I don't see these as "concepts", I see these as component names. A bit unrelated to capitalization, I'm wondering if we should remove the links on all of the top-level index items. So for example, "Dependency Injection" would change to "DependencyInjection", but we'd also remove the link. The issue is that I often see people click that top-level link only to then stare at the next index page, wondering what to do next. The first link under each component should (I think) take you to the introduction page.

In areas where we do actually say "dependency injection pattern", then clearly that's a concept - so once again, I agree. But I imagine that almost every time we say "Dependency Injection" in the components docs, we're referring to the component, not the concept.

I'll see if anyone else has any suggestions and look to merge this in a few days :).

Cheers!

@bicpi
Copy link
Contributor Author

bicpi commented Nov 16, 2013

Hi Ryan, sounds good. I'll once again page through the docs and update the "Dependency Injection" thing, especially regarding the index. I'll also update the components index page as suggested.

Regarding the links on the components index page, let's wait for comments - if we remove the links I can include this later :-)

@bicpi
Copy link
Contributor Author

bicpi commented Nov 17, 2013

I've updated Class Loader, CSS Selector, DOM Crawler, Dependency Injection, HTTPKernel and Options Resolver to use the real component names on the components overview page and in the index.

@xabbuh
Copy link
Member

xabbuh commented Nov 17, 2013

So for example, "Dependency Injection" would change to "DependencyInjection", but we'd also remove the link. The issue is that I often see people click that top-level link only to then stare at the next index page, wondering what to do next. The first link under each component should (I think) take you to the introduction page.

👍 We can keep the index documents, but for the everyday usage it's better to link directly to the introduction chapters.

@wouterj
Copy link
Member

wouterj commented Nov 17, 2013

But then, all index pages are sort of useless as nothing links to it...

@bicpi
Copy link
Contributor Author

bicpi commented Nov 17, 2013

Thought about the link problem, too. What about linking the index explicitly by some [index] suffix?
But this may looks ugly.

@xabbuh
Copy link
Member

xabbuh commented Nov 17, 2013

Well, the index page is at least still useful if you want to link to an overview of a particular component/section from your own blog, etc.

@weaverryan weaverryan merged commit 00af1dd into symfony:2.2 Nov 18, 2013
@weaverryan
Copy link
Member

Hi guys!

I've merged this in since the links idea was really unrelated to this (my fault!). I don't feel too strongly one way or another about the links - I would prefer to link to the introduction, but I agree that it sort of makes the index pages useless (though I think we may at least have some internal breadcrumbs links to them).

Thanks!

@bicpi bicpi deleted the component_names_consistency branch January 5, 2014 13:24
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