starred/terminal
1
0
Fork 0
mirror of https://github.com/microsoft/terminal.git synced 2026-02-03 21:25:34 +00:00
Code Issues 19.0k Packages Projects Releases 20 Wiki Activity

Reconcile ./docs folder versus using the Wiki feature of GitHub #906

New Issue
Closed
opened 2026-01-30 22:09:44 +00:00 by claunia · 7 comments
claunia commented 2026-01-30 22:09:44 +00:00
Owner
Copy Link

Originally created by @miniksa on GitHub (May 9, 2019).

Originally assigned to: @cinnamon-msft on GitHub.

Folks are trying to add Wiki pages, but we already have a pile of docs in the ./docs folder.

This represents figuring out where we want to keep a majority of the authoritative knowledge about the project.

The verbal discussion in triage is that they both use Markdown, so we should probably just pick one.

Kayla said she'd think it through and figure it out.

Originally created by @miniksa on GitHub (May 9, 2019). Originally assigned to: @cinnamon-msft on GitHub. Folks are trying to add Wiki pages, but we already have a pile of docs in the ./docs folder. This represents figuring out where we want to keep a majority of the authoritative knowledge about the project. The verbal discussion in triage is that they both use Markdown, so we should probably just pick one. Kayla said she'd think it through and figure it out.
claunia added the Resolution-Fix-AvailableIssue-DocsProduct-MetaArea-CodeHealth labels 2026-01-30 22:09:44 +00:00
claunia commented 2026-01-30 22:09:45 +00:00
Author
Owner
Copy Link

@binarycrusader commented on GitHub (May 9, 2019):

The one big downside I know of is that wikis can't be easily forked; there's chatter about this here:
https://stackoverflow.com/questions/7197937/on-github-can-i-fork-just-a-wiki

@binarycrusader commented on GitHub (May 9, 2019): The one big downside I know of is that wikis can't be easily forked; there's chatter about this here: https://stackoverflow.com/questions/7197937/on-github-can-i-fork-just-a-wiki
claunia commented 2026-01-30 22:09:45 +00:00
Author
Owner
Copy Link

@vapier commented on GitHub (May 11, 2019):

one downside of not keeping docs in the git repo itself is you can't easily branch/snapshot/version the docs with every release. the wiki always reflects the latest code which might not make sense for a release from a few months ago. so projects will often try to balance those competing priorities by keeping some docs in the git repo (which make sense on a per-branch/release basis) and keep everything else as a living/latest doc in the wiki.

@vapier commented on GitHub (May 11, 2019): one downside of not keeping docs in the git repo itself is you can't easily branch/snapshot/version the docs with every release. the wiki always reflects the latest code which might not make sense for a release from a few months ago. so projects will often try to balance those competing priorities by keeping some docs in the git repo (which make sense on a per-branch/release basis) and keep everything else as a living/latest doc in the wiki.
claunia commented 2026-01-30 22:09:45 +00:00
Author
Owner
Copy Link

@cinnamon-msft commented on GitHub (May 14, 2019):

@miniksa I think we're all in agreement that everything should be in the ./docs folder, to allow for version tracking and PRs

@cinnamon-msft commented on GitHub (May 14, 2019): @miniksa I think we're all in agreement that everything should be in the ./docs folder, to allow for version tracking and PRs
claunia commented 2026-01-30 22:09:45 +00:00
Author
Owner
Copy Link

@miniksa commented on GitHub (May 14, 2019):

@cinnamon-msft, OK. Then we should probably formalize the policy in the README.md and maybe also leave a single Wiki page up that says "NO NOT HERE, PUT IT IN DOCS."

Can you do that?

@miniksa commented on GitHub (May 14, 2019): @cinnamon-msft, OK. Then we should probably formalize the policy in the `README.md` and maybe also leave a single Wiki page up that says "NO NOT HERE, PUT IT IN DOCS." Can you do that?
claunia commented 2026-01-30 22:09:46 +00:00
Author
Owner
Copy Link

@cinnamon-msft commented on GitHub (May 14, 2019):

@miniksa I'm happy to add something to the README.md. I also just noticed we can disable the wiki entirely, would that be a better option to avoid confusion?

@cinnamon-msft commented on GitHub (May 14, 2019): @miniksa I'm happy to add something to the `README.md`. I also just noticed we can disable the wiki entirely, would that be a better option to avoid confusion?
claunia commented 2026-01-30 22:09:46 +00:00
Author
Owner
Copy Link

@vapier commented on GitHub (May 14, 2019):

if the wiki isn't going to be used at all, just disable it ? you can do that under the project settings in github. then there won't even be a "wiki" tab at all.

@vapier commented on GitHub (May 14, 2019): if the wiki isn't going to be used at all, just disable it ? you can do that under the project settings in github. then there won't even be a "wiki" tab at all.
claunia commented 2026-01-30 22:09:46 +00:00
Author
Owner
Copy Link

@cinnamon-msft commented on GitHub (May 15, 2019):

Policy has been added to README.md and wiki has been disabled

@cinnamon-msft commented on GitHub (May 15, 2019): Policy has been added to `README.md` and wiki has been disabled
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
⛺ Reserved
A11yCO
A11yMAS
A11ySev1
A11ySev2
A11ySev3
A11yTTValidated
A11yUsable
A11yVoiceAccess
A11yWCAG
Area-Accessibility
Area-AtlasEngine
Area-AzureShell
Area-Build
Area-Build
Area-Chat
Area-CmdPal
Area-CodeHealth
Area-Commandline
Area-CookedRead
Area-DefApp
Area-Extensibility
Area-Fonts
Area-GroupPolicy
Area-i18n
Area-Input
Area-Interaction
Area-Interop
Area-Localization
Area-Output
Area-Performance
Area-Portable
Area-Quality
Area-Remoting
Area-Rendering
Area-Schema
Area-Server
Area-Settings
Area-SettingsUI
Area-ShellExtension
Area-ShellExtension
Area-ShellExtension
Area-Suggestions
Area-Suggestions
Area-TerminalConnection
Area-TerminalControl
Area-Theming
Area-UserInterface
Area-VT
Area-Windowing
Area-WPFControl
AutoMerge
Blocking-Ingestion
Culprit-Centennial
Culprit-WinUI
Disability-All
Disability-Blind
Disability-LowVision
Disability-Mobility
External-Blocked-WinUI3
Fixed
Gathering-Data
good first issue
HCL-E+D
HCL-WindowsTerminal
Help Wanted
Impact-Compatibility
Impact-Compliance
Impact-Correctness
Impact-Visual
In-PR
InclusionBacklog
InclusionBacklog-Windows TerminalWin32
InclusionCommitted-202206
Issue-Bug
Issue-Docs
Issue-Feature
Issue-Feature
Issue-Question
Issue-Samples
Issue-Scenario
Issue-Task
Needs-Attention
Needs-Author-Feedback
Needs-Bisect
Needs-Discussion
Needs-Repro
Needs-Tag-Fix
Needs-Tag-Fix
Needs-Triage
No-Recent-Activity
Priority-0
Priority-1
Priority-2
Priority-3
Product-Cmd.exe
Product-Colortool
Product-Colortool
Product-Colortool
Product-Conhost
Product-Conpty
Product-Meta
Product-Powershell
Product-Terminal
Product-WSL
pull-request
Mirrored from GitHub Pull Request
 Resolution-Answered
Resolution-By-Design
Resolution-Duplicate
Resolution-External
Resolution-Fix-Available
Resolution-Fix-Committed
Resolution-No-Repro
Resolution-Won't-Fix
Severity-Blocking
Severity-Crash
Severity-DataLoss
spam
this-will-be-a-breaking-change
Tracking-External
WindowsTerminal_Win32
Work-Item
zAskModeBug
zInbox-Bug
No Label Area-CodeHealth Issue-Docs Product-Meta Resolution-Fix-Available
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
claunia
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#906
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?