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

Re-order the table of contents #393

Closed
MelSumner opened this issue Feb 7, 2019 · 4 comments
Closed

Re-order the table of contents #393

MelSumner opened this issue Feb 7, 2019 · 4 comments
Assignees
Labels
Octane time-sensitive It is important that this task be finished very quickly

Comments

@MelSumner
Copy link
Member

MelSumner commented Feb 7, 2019

Following the direction outlined in RFC 431, re-order the table of contents for the guides.

Because of the Guides app architecture, we can move content around while preserving existing links. The Table of Contents specified in the pages.yml file of guides-source can have any paths, and is not 100% dependent on the physical file structure to create URLs.

Order:

  • What is Ember?
  • Getting Started
  • Tutorial
  • The Object Model
  • Templates
  • Components
  • Controllers
  • Routing
  • State management
  • Services
  • Ember Data (renamed from "Models")
  • Addons and dependencies
  • Testing
  • Configuration (renamed from "Configuring Ember.js")
  • Application Concerns
  • Ember Inspector
  • Contributing to Ember.js
  • Glossary

New sections are in bold.

@MelSumner MelSumner added Octane time-sensitive It is important that this task be finished very quickly labels Feb 7, 2019
@MelSumner MelSumner assigned MelSumner and locks and unassigned MelSumner Feb 7, 2019
@locks
Copy link
Contributor

locks commented Feb 8, 2019

The following sections are missing from the listing: "The Object Model", "Controllers", "Contributing to Ember.js", "Glossary".

@MelSumner
Copy link
Member Author

MelSumner commented Feb 8, 2019

@locks this was copied and pasted directly from "what does an MVP look like"

The RFC states these things:

  • the object model section is getting removed

Notably missing is "Ember Object Model." This is on purpose. It will be pulled into other sections, in a “show, don’t tell” kind of approach. Also removed is "Application Concerns," which are separated into their appropriate alternate subtopics.

  • controllers are going under routing

This RFC proposes grouping Routes, Routing, and Controllers under the same topic heading.

I think that for now, Glossary and Contributing to Ember should go under References if they need to move at all. I'm not comfortable completely removing them just yet. @jenweber can clarify if she can speak more to her planning intent.

Does that sound okay?

@locks
Copy link
Contributor

locks commented Feb 9, 2019

We had a call and discussed how to break down the work necessary to complete this task in a way that allows the learning team to continuously release content with minimal impact to the stability of URLs and such.

To that end, the approach is going to roughly be:

  1. Re-order and re-title sections. Since this keeps the current URLs, the only impact will be for the "previous"/"next" hyperlinks at the bottom of each page.
  2. Add placeholders for the new top-level sections
    2.1. Add placeholders for new sub-sections
    2.2. Fill out new content
  3. Remove content and set up relevant redirects

MelSumner added a commit that referenced this issue Feb 15, 2019
If merged into the octane branch, this PR resolves issue #393 by re-ordering the table of contents (as outlined in RFC 431).
jenweber pushed a commit that referenced this issue Feb 18, 2019
If merged into the octane branch, this PR resolves issue #393 by re-ordering the table of contents (as outlined in RFC 431).
@acorncom
Copy link
Member

Looks to have been fixed by #459

lenoraporter pushed a commit to lenoraporter/guides-source that referenced this issue Jul 19, 2020
If merged into the octane branch, this PR resolves issue ember-learn#393 by re-ordering the table of contents (as outlined in RFC 431).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Octane time-sensitive It is important that this task be finished very quickly
Projects
None yet
Development

No branches or pull requests

3 participants