Repository navigation
organize markdown files #304
Description
We have lots of markdown files relating to building, debugging, issue management, style, API reviews and suchlike. These are mostly inherited from the original repos and there is duplication, obsolete material, and incorrect material.
Someone needs to take a look and decide what should happen to each doc, how they should be laid out and enumerate what work is needed so several of us can help do it.
@maryamariyan has volunteered to do this.
Activity
jkotas commentedon Nov 26, 2019
From #251 (comment):
docs\workflow\profilingtalks about profiler API architecture (e.g. how one builds a CoreCLR profiler). It should not be under workflow.danmoseley commentedon Nov 26, 2019
This would be a great place for folks to share other suggestions about those docs. Here's a list of all the markdown files, minus ones that are most obviously not affected by the consolidation and stand alone.
jkotas commentedon Nov 26, 2019
src\libraries\SECURITY.md should be deleted. Redundant with SECURITY.md at the root.
jkotas commentedon Nov 26, 2019
workflow described in docs\project\changing-corelib.md is not relevant for consolidated repo. This file should be deleted.
Remove doc files not meant for dotnet/runtime (#311)
ViktorHofer commentedon Nov 26, 2019
I removed a few files from the list like eng/common/REAMDE.md and the ones which were just deleted.
danmoseley commentedon Nov 28, 2019
#253 (comment) suggests
tmds commentedon Dec 12, 2019
We can also improve for new contributors. There is no path from README that gets you to instructions that show how to build/test/... this repo.
ViktorHofer commentedon Dec 12, 2019
There is a link to CONTRIBUTING.md which is the go-to place for such information: https://github.com/dotnet/runtime#how-can-i-contribute. We are probably missing links to the workflow docs from the CONTRIBUTING.md. Feel free to submit a PR to link to those. We still haven't cleaned up the docs.
dhusemann commentedon Dec 12, 2019
@danmosemsft @ViktorHofer @maryamariyan Believe that all the links for Contributing.md have been updated. with #815. Is the workflow directory going to remain the same layout??
One thing I just noticed, with the delay of moving the Issues from the Coreclr and corefx repo's to runtime, that there will be a disconnect with finding the issues.
danmoseley commentedon Dec 14, 2019
I hit the same issue, contributing doesn't tell me HOW to contribute.
@maryamariyan any thoughts? i can help organize/move docs around, if you suggest what we need/ what should link where?
Add up for grabs links to coreFX and coreCLR
dhusemann commentedon Dec 14, 2019
another question, some of the DOCS for building refer to repos that are going to be consolidated. Such as referring to dotnet/cli which has moved to dotnet/toolset which in turn will eventually be consolidated into dotnet/sdk.
Do ya'll want to wait for those repo's to fully consolidate before updating, or do an interim update as an example #881
ViktorHofer commentedon Dec 15, 2019
An interim update sounds fine. We can a final update after the repos consolidate with a search&replace then.
Add up for grabs links to coreFX and coreCLR (#881)
danmoseley commentedon Jan 3, 2020
Is it reasonable to combine these? (append the latter to the former)? I always look for one and find the other -- or if I'm reading one I need the other.