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

☂ [Tracking] Site information architecture restructure #4565

Open
MaryaBelanger opened this issue Jan 31, 2023 · 0 comments
Open

☂ [Tracking] Site information architecture restructure #4565

MaryaBelanger opened this issue Jan 31, 2023 · 0 comments
Assignees
Labels
a.language Relates to the Dart language tour e4-months Can complete in >= 1 month of normal, not dedicated, work from.team Reported by Dash docs team member infra.ia Relates to the organization of pages and structuring of content meta.umbrella Collects multiple related issues p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@MaryaBelanger
Copy link
Contributor

MaryaBelanger commented Jan 31, 2023

WIP

The site architecture needs to be restructured.

  • There's no obvious progression of concepts evident from the landing page, the left nav, etc.
  • When it's time to update content or add new information, it's a nightmare deciding where it should go/where to look for potential areas to update.

The sections below are the major chunks of work that will go into the site restructure (each will have it's own issue or PR to further elaborate on):

1. Disassemble the Language tour

Dedicated issue: #4588

The first undertaking will be taking apart the language tour by section/topic, and moving those sections directly under "Language" (in the left nav) as separate pages. An "umbrella" topic (e.g. Classes, Types, Concurrency, etc.) can have multiple other concepts under it (e.g. Classes: Constructors, Methods, etc.).

Why?

The language tour contains basically all the information on the site. It's problematic though.

  • set up like something that's supposed to be read end to end, but really shouldn't be
  • hides content, topics
  • forces longer explanations to be broken out into separate pages, so there's duplicated information, "extra" content floating around
  • What's the language tour actually for? How to do things? Is it a Dart overview? A reference? It's a mix of everything, so it's not really anything.
  • Suspicion that it negatively affects SEO because it's just a huge page with everything in it.

2. Restructure the left nav

Restructuring at least the Language section of the left nav will have to happen in conjunction with breaking down the language tour, since everything will go there.

New left nav will be something like:

├─ Get Started                               # see "Getting started" section
├─ _Dart Tutorials_                       # see  "Samples & tutorials" section
├─ Language                                 # eliminate the `/guides` folder and have everything under `/language` directly
    ├─ Every
    ├─ Major
    ├─ Language
    ├─ Concept                                # see Define content types section
        ├─ Conceptual overview
        ├─ Guide(s)
        ├─ Full reference
├─ Libraries                                    # probably also take apart the Library tour
    ├─ Page
    ├─ per 
    ├─ Library
├─ _Development_
├─ _Packages_
├─ _Tools & Techniques_
├─ Reference
    ├─ _Effective Dart_                    # tbd, I think it's a reference. I could also be top level (in-line with Language, Packages, etc)
    ├─ Glossary                                # see "Site-wide Glossary" section
    ├─ Language Evolution
    ├─ Dart Specification
    ├─ FAQ
├─ Related Sites

As we decide what the rules are, we need to clearly define those somewhere and stick to them.

Define content types

Solution in progress

Clearly defined content types does a couple things:

  • let's users know exactly what they're looking at and where to look for different kinds of information
  • let's writers fill in preset templates for new content and know exactly where to update different kinds of information

Create a "Getting Started" guide

Solution in progress

"Getting started" is a single page that points to the most important introductory resources to learn and start using Dart, laid out in the logical, sequential progression of topics, with a short summary about each.

Samples and tutorials overhaul

Solution in progress

This overhaul is less about restructuring in the context of the entire site, and more about cleaning up/ organizing the pages within the section.

Site-wide "Glossary"

#4622

Redirects

Solution in progress

  • Redirects will be a big issue,
  • Maaaybe use javascript to redirect

Other top level sections

Solution in progress

Haven't really analyzed Packages, Development, Tools & techniques sections yet, but at the very least their contents should be scrutinized to ensure they're under the appropriate heading. E.g.:

  • "Futures, async, await" and "Streams" don't need to be under Development header
  • "Tools & techniques" has some widely varying topics under it, maybe some of those should be separated into top level sections?
@MaryaBelanger MaryaBelanger self-assigned this Jan 31, 2023
@parlough parlough added a.language Relates to the Dart language tour p1-high Major but not urgent concern: Resolve in months. Update each month. docs e4-months Can complete in >= 1 month of normal, not dedicated, work infra.ia Relates to the organization of pages and structuring of content labels Jan 31, 2023
@atsansone atsansone added meta.umbrella Collects multiple related issues st.triage.ltw Indicates Lead Tech Writer has triaged and removed docs labels May 6, 2023
@parlough parlough added p2-medium Necessary but not urgent concern. Resolve when possible. and removed p1-high Major but not urgent concern: Resolve in months. Update each month. labels Jun 12, 2023
@atsansone atsansone added the from.team Reported by Dash docs team member label Aug 8, 2023
@atsansone atsansone changed the title [Tracking] Site information architecture restructure ☂ [Tracking] Site information architecture restructure Aug 10, 2023
parlough added a commit that referenced this issue May 6, 2024
Contributes to #5767 and
#4565 by moving a few
isolated pages within the `/guides` directory that have an existing
suitable location to there.

These are grouped as an initial step as they don't require larger
content or restructuring changes, unlike some other pages within the
`/guides` directory.

| Original location | New location |
|--------|--------|
| `/guides/libraries/useful-libraries` | `/resources/useful-packages` |
| `/guides/libraries/writing-package-pages` |
`/tools/pub/writing-package-pages` |
| `/guides/google-apis` | `/resources/google-apis` |
| `/guides/language/coming-from/**` | `/resources/coming-from/**` |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a.language Relates to the Dart language tour e4-months Can complete in >= 1 month of normal, not dedicated, work from.team Reported by Dash docs team member infra.ia Relates to the organization of pages and structuring of content meta.umbrella Collects multiple related issues p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

3 participants