Skip to content

7.x to 8.x reference/concept documentation #491

Open

Description

@Arlodotexe

What we're doing

For concept/wiki-like docs, we need to close off this old repo by redirecting its contents to the new repo.

If we have a list or set of guidance for general mapping, we can open up a doc request for the doc team to help us with this.

Why we're doing it

There is no published reference documentation for any Community Toolkit beyond 7.1, and there should be.

Our processes have changed, new major versions were released, new toolkits were created, and our reference docs are neither well-updated nor well-consolidated.

Further, the sample/concept/wiki-like docs for 7x do not redirect to the latest in 8x, and they should.

What we know

A full evaluation and grouping of the concept docs in the old repo are needed to move them to the new repo, including:

  • A list of all Community Toolkit variants, packages and package versions being migrated.
  • Which packages/namespaces/types need to be mapped to 8x+ code.
  • Which packages/namespaces/types need to be redirected due to deprecation.

The Windows Community Toolkit will have reference docs since 8.x generated automatically per-major and per-minor version. We simply need to supply a list of packages (grouped by version) which need to be published on MSLearn.

Docs Publish state Location Needs
7x 8x 7x 8x 7x 8x
Samples / concept Published Published Link Link Map to 8x -> Map from 7x
Reference Published Unpublished Link n/a Map to? Generate. Docs team can do this, but needs package list.

What we need to know

These are also being requested and will need details:

  • The schema of the existing reference doc maps is ambiguous.
    • Will these be generated by the docs team from the nuget packages?
  • The intended placement and grouping of reference documentation per-version in the new repository is ambiguous, as it contains only wiki-like sample documentation.
    • Where will the generated reference documentation be stored? In the current concept/sample doc repo, or somewhere else?
  • Release cycle of the MAUI Community Toolkit is unknown
  • Release cycle of the Aspire Community Toolkit is unknown
  • Release cycle of the Datasync Community Toolkit is unknown

Overall, this task is missing a significant number of high-level details around what needs changed and the approach.

Activity

  1. self-assigned this
    on Aug 26, 2024
  2. converted this from a draft issue on Aug 26, 2024
  3. added
    documentationImprovements or additions to documentation
    external ⤴️Requires an update to an external dependency or due to code outside the Toolkit.
    on Aug 26, 2024
  4. changed the title [-]7.x to 8.x documentation redirects[/-] [+]7.x to 8.x wiki/bespoke documentation redirects[/+] on Mar 20, 2025
  5. moved this from 🔖 Ready to 🏗 In progress in Toolkit 8.xon Apr 7, 2025
  6. changed the title [-]7.x to 8.x wiki/bespoke documentation redirects[/-] [+]7.x to 8.x concept documentation redirects[/+] on Apr 10, 2025
  7. changed the title [-]7.x to 8.x concept documentation redirects[/-] [+]7.x to 8.x reference documentation redirects[/+] on Apr 10, 2025
  8. changed the title [-]7.x to 8.x reference documentation redirects[/-] [+]7.x to 8.x reference documentation[/+] on Apr 10, 2025
  9. changed the title [-]7.x to 8.x reference documentation[/-] [+]7.x to 8.x reference/concept documentation[/+] on Apr 10, 2025
  10. Arlodotexe commented on Apr 10, 2025

    @Arlodotexe
    MemberAuthor

    Updating to clarify the distinction between work needed for Concept/Wiki-like docs and generated Reference docs.

  11. Arlodotexe commented on Apr 10, 2025

    @Arlodotexe
    MemberAuthor

    I've also noticed if you try to browse to the 7.1 reference docs, they redirect to the 7.0 reference docs.

  12. Arlodotexe commented on Apr 10, 2025

    @Arlodotexe
    MemberAuthor

    A complete and up-to-date list of 8x NuGet packages can be found in our Component Area Map

  13. michael-hawker commented on Apr 10, 2025

    @michael-hawker
    Member

    Fixed you Samples / concepts 7x link ;) (windows/communitytoolkit)

    If we have an Excel or csv of the mapping of urls between the articles of the two sets of sample/concept docs, then we can get the doc team to configure the redirect json bits and how that works across repos.

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationexternal ⤴️Requires an update to an external dependency or due to code outside the Toolkit.

Type

No type

Projects

  • Status
    🏗 In progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions