Skip to content
This repository has been archived by the owner on Jan 23, 2023. It is now read-only.

Add subfolders to Documentation folder #1114

Merged
merged 2 commits into from
Jun 10, 2015
Merged

Add subfolders to Documentation folder #1114

merged 2 commits into from
Jun 10, 2015

Conversation

blackdwarf
Copy link

As raised in #1075 by @akoeplinger, the Documentation folder's file
list forces the user to scroll way down to see the README.md. This
PR fixes that by storing the documents in separate sub-folders one
per hierarchy of related documents. Also changed
Documentation\README.md and root README.md to take into account
the new paths.

/cc @richlander @akoeplinger @terrajobst @kangaroo

@dnfclas
Copy link

dnfclas commented Jun 7, 2015

Hi @blackdwarf, I'm your friendly neighborhood .NET Foundation Pull Request Bot (You can call me DNFBOT). Thanks for your contribution!

In order for us to evaluate and accept your PR, we ask that you sign a contribution license agreement. It's all electronic and will take just minutes. I promise there's no faxing. https://cla2.dotnetfoundation.org.

TTYL, DNFBOT;

@dnfclas
Copy link

dnfclas commented Jun 7, 2015

@blackdwarf, Thanks for signing the contribution license agreement so quickly! Actual humans will now validate the agreement and then evaluate the PR.

Thanks, DNFBOT;

@akoeplinger
Copy link
Member

LGTM, thanks for doing this work 👍

Can we integrate the content of dotnetcore-intro.md into README.md as well? It's just a single paragraph so I don't think it warrants a separate file at the root.

@kangaroo
Copy link

kangaroo commented Jun 7, 2015

LGTM

@blackdwarf
Copy link
Author

@akoeplinger Agreed. @richlander are you ok with this suggestion?

@richlander
Copy link
Member

Thanks for doing this @blackdwarf. Few comments.

  • Including the brief intro in the readme is fine.

I'd prefer to following directories:

  • installing -> install
  • building -> build
  • project-docs
  • coding-guidelines
  • botr
  • decoders -> project-docs
  • misc -> project-docs

Basically, I'd prefer not to use gerunds.

@richlander
Copy link
Member

Looks like you should rebase master on your change. I merged in an update earlier tonight. Not surprisingly not compatible with a rename PR.

blackdwarf pushed a commit that referenced this pull request Jun 10, 2015
@blackdwarf
Copy link
Author

OK, fixed the folder name as per @richlander suggestion, However, I cannot rename building to build, since build/ is in .gitignore. Don't want to mess with that at this point, so I suggest we just leave it as is, unless someone can educate me on the best way to do this. :)

@richlander
Copy link
Member

@blackdwarf good point! Please ignore my aesthetics on that issue. It is not worth futzing with .gitignore to make it work.

Zlatko Knezevic added 2 commits June 10, 2015 09:50
As raised in #1075 by @akoeplinger, the Documentation folder's file
list forces the user to scroll way down to see the README.md. This
PR fixes that by storing the documents in separate sub-folders one
per hierarchy of related documents. Also changed
Documentation\README.md and root README.md to take into account
the new paths.
blackdwarf pushed a commit that referenced this pull request Jun 10, 2015
Add subfolders to Documentation folder
@blackdwarf blackdwarf merged commit b23b65a into master Jun 10, 2015
@blackdwarf blackdwarf deleted the docs-subfolders branch June 10, 2015 18:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants