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

Executive overview for Version-by-File support #32487

Open
guardrex opened this issue May 1, 2024 · 1 comment
Open

Executive overview for Version-by-File support #32487

guardrex opened this issue May 1, 2024 · 1 comment
Assignees
Labels

Comments

@guardrex
Copy link
Collaborator

guardrex commented May 1, 2024

@Rick-Anderson @tdykstra @wadepickett ... Per internal discussion with PU management, I'll be preparing an executive overview to try and get support for implementing Version-by-File support. IIRC, there were two problems that I faced with my implementation that remained unsupported, thus forcing me to abandon it ...

  • Localization was either broken or heavily delayed.
  • The sidebar ToC wouldn't highlight the correct article that the dev was reading for non-current-release articles.

Otherwise, everything seemed to work great. Cross-links and navigation worked great, and there was no duplicate heading problem with copied content because each copy of the content was in a separate file. Docs would've been easy to update and maintain because all docs for a given release were in one folder named for its version (i.e., 3.1, 5.0, 6.0, etc.). You could simply set a search filter on a given release folder to isolate content for find-'n-replace updates (e.g., sample cross-links). It was really nice, and I could see how it would save a lot of time ... thus 💰💰💰💰.

I won't reach this for a few weeks. I need to get a Blazor tutorial written and work up the Pre4 Blazor coverage first. The purpose of this issue is primarily to track it as a work item. If you have input on this, you can email me. I'll email the draft to you for comments when it's ready.

@guardrex guardrex self-assigned this May 1, 2024
@github-actions github-actions bot added the Blazor label May 1, 2024
@guardrex guardrex added Pri1 High priority, do before Pri2 and Pri3 docs-experience labels May 1, 2024
@dotnet dotnet deleted a comment from github-actions bot May 1, 2024
@Rick-Anderson
Copy link
Contributor

  • Localization was either broken or heavily delayed.

Loc is gone, there is no more loc.

I won't reach this for a few weeks.

Let me know a couple days before you start and I'll arrange for support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: P0/P1 - High Priority
Development

No branches or pull requests

3 participants