Skip to content

Planning documentation release for 8.2 stable #629

Closed
1 of 2 issues completed
Closed

Description

@Arlodotexe

Background

Windows Community Toolkit 8.2 is slated to release soon, with 8.2-preview2 already in flight.

When we create a new stable release, we make sure to update the documentation published on Microsoft Learn, which is sourced from here..

To generate these files from the interactive Markdown sample documentation we write in the gallery, we use the ./tooling/Build-Toolkit-Docs.ps1 script to transform between gallery-compatible and mslearn-compatible markdown.

Problem

To facilitate a smooth release, we need to ensure that the documentation we publish on Microsoft Learn is updated with the latest documentation from our repository.

Solution

Release refactored and improved documentation

Activity

  1. michael-hawker commented on Feb 12, 2025

    @michael-hawker
    Member

    We need to finish the migration of the mapping from the old docs: https://learn.microsoft.com/en-us/windows/communitytoolkit/ hosted in https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs - so that the old doc urls best get redirected to new ones and we can archive the old repository pointing to the new MicrosoftDocs/CommunityToolkit repo.

    I think we also have some odd structure in the new docs due to how we copy/export the docs via the script, so that may be something to evaluate, though fixing would also require redirects.

  2. Arlodotexe commented on Feb 12, 2025

    @Arlodotexe
    MemberAuthor

    We need to finish the migration of the mapping from the old docs: https://learn.microsoft.com/en-us/windows/communitytoolkit/ hosted in https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs - so that the old doc urls best get redirected to new ones and we can archive the old repository pointing to the new MicrosoftDocs/CommunityToolkit repo.

    I think we also have some odd structure in the new docs due to how we copy/export the docs via the script, so that may be something to evaluate, though fixing would also require redirects.

    We've already done a significant number of these, we need #602 to make further progress here.

    For this ticket specifically, let's focus on what we can do for the 8.2 release this week and follow-up on this soon after. Especially since we can push smaller updates to docs at any time.

  3. self-assigned this
    on Mar 20, 2025
  4. moved this to 🏗 In progress in Toolkit 8.xon Mar 20, 2025
  5. Arlodotexe commented on Apr 3, 2025

    @Arlodotexe
    MemberAuthor

    The generated Wiki-like sample docs for the 8.2 release were submitted here. The published documentation can be found here.

  6. moved this from 🏗 In progress to ✅ Done in Toolkit 8.xon Apr 3, 2025
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 documentation

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions