-
Notifications
You must be signed in to change notification settings - Fork 6k
create initial contributing.md for fast releases. #1206
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
Merged
BillWagner
merged 10 commits into
dotnet:master
from
BillWagner:create-current-release-structure
Nov 10, 2016
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
47b5014
create initial contributing.md for fast releases.
BillWagner b1ebe66
fix markdown syntax issue.
BillWagner 48efdb6
fix the link to the main docs folder.
BillWagner 601b369
one more time, fixing the link.
BillWagner 662c1d5
add note about contributing.md location.
BillWagner 13ce63c
Add any contributing.md files to the exclude list
BillWagner b16012c
stashing to switch branches.
BillWagner 160dced
update the link in the warning include.
BillWagner 0a9a6c0
update with correct current release terms.
BillWagner 342e2c2
Update for feedback.
BillWagner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Using the current-1.1 folder and sub-folders | ||
|
||
This folder is the top-level node that matches the [docs](../welcome.md) | ||
folder, but contains deltas for the .NET Core 1.1 release. | ||
|
||
The goal of this separate parallel folder structure is to provide a location | ||
for the 1.1 release related content that can be relatively easily merged into | ||
the main structure when provide version switching in the published site. | ||
|
||
The content under this node should be a smaller document set that represents | ||
the deltas from the Long Term Support (LTS) release and the latest | ||
current release. | ||
|
||
## Structure | ||
|
||
There are two cases to adding new content for this release: | ||
|
||
* Changes to existing documents | ||
- Copy the existing content into a parallel folder under this structure. Make your changes, and add the modified file to the TOC for the 1.1 preview release. | ||
* New documents | ||
- Put the new document in the proper location, and add it to the TOC under the node for the 1.1 preview release. | ||
|
||
All current release files should have the following added near the | ||
top of the topic: | ||
|
||
[!include[current release track](../includes/warning.md)] | ||
|
||
We've created a snippet to include with the following syntax: | ||
|
||
```markdown | ||
[!include[current release track](../includes/warning.md)] | ||
``` | ||
|
||
### Link instructions | ||
|
||
In both cases, provide links from current release to the LTS page (or parent index.md) | ||
for navigational purposes. | ||
Consider providing links from the LTS page (or parent index.md) to the | ||
new current release content page. | ||
|
||
## Future Considerations | ||
|
||
Our end goal is to surface different releases as branches in the | ||
[docs repo](https://github.com/dotnet/docs). Until that publishing | ||
scenario is supported, we'll use different top-level folders for each | ||
current release. | ||
|
||
When the time comes, we can merge each current release into the main | ||
[docs](../docs) folder, merge the TOC nodes, and publish as a separate doc | ||
set. We may need to merge modifications to both the LTS version of a file | ||
and the current release of a file, but we should be able to find those | ||
changes relatively easily. | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
> [!WARNING] | ||
> This topic represents *current release* software. This version will be supported | ||
> only until the following current lease. For the latest Long Term Release information, | ||
> see [the major release version documentation](/articles/core/index.md) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need agreement on the folder name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe /cc @richlander
This was the name displayed today.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have a strong preference, but I was just wondering if the folder name should have core like core-current or something like that, to make it clear the content in that folder is for .net core.