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.

Sign up for GitHub

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

Jump to bottom

Documentation layout for proposals #8671

Closed
rainersigwald opened this issue Apr 17, 2023 · 0 comments · Fixed by #8701
Closed

Documentation layout for proposals #8671

rainersigwald opened this issue Apr 17, 2023 · 0 comments · Fixed by #8701
Assignees
@JanKrivanek
Labels
Documentation Issues about docs, including errors and areas we should extend (this repo and learn.microsoft.com) needs-design Requires discussion with the dev team before attempting a fix. triaged
Milestone
VS 17.7

Comments

@rainersigwald
Copy link
Member

We were discussing the right home for docs that represent proposed-but-not-yet-accepted designs. It's nice to be able to check them in as point-in-time artifacts and close PRs creating them, even if we're not going to move forward with a specific plan right now.

We currently have documentation/specs and documentation/design.

We should unify those and have a proposed or working folder.

Proposal from @JanKrivanek:

  • documentation/specs is "accepted"
  • documentation/specs/proposed is "not accepted, still working or paused"
  • documentation/specs/archive is "explicitly rejected with reasoning for posterity".

That works for me.
@rainersigwald rainersigwald added needs-design Requires discussion with the dev team before attempting a fix. Documentation Issues about docs, including errors and areas we should extend (this repo and learn.microsoft.com) labels Apr 17, 2023
@rainersigwald rainersigwald added this to the VS 17.7 milestone Apr 17, 2023
@JanKrivanek JanKrivanek mentioned this issue Apr 25, 2023
Merged
Forgind pushed a commit that referenced this issue May 1, 2023
@JanKrivanek
Reorganize docs (#8701)
956d69f 
Fixes #8671

Context
New layout as agreed offline

specs             (content remains same, we'll move here rar-core-scenarios from documentation/design folder)
 |-----proposed   (the secrets metadata and packages sourcing PRs would get routed here. In future - all in-progress work specs)
 |-----archive    (the rar-as-service.md from documentation/design will get moved here. In future - all not dismissed but not planned feature spec goes here)
Moving facilitated via git mv to preserve history and make diffs conscise
@AR-May AR-May added the triaged label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JanKrivanek JanKrivanek

Labels
Documentation Issues about docs, including errors and areas we should extend (this repo and learn.microsoft.com) needs-design Requires discussion with the dev team before attempting a fix. triaged
Projects
None yet
Milestone
VS 17.7
Development

Successfully merging a pull request may close this issue.

Reorganize docs JanKrivanek/msbuild
3 participants
@rainersigwald @JanKrivanek @AR-May