Skip to content

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
merged 10 commits into from
Nov 10, 2016
2 changes: 1 addition & 1 deletion docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"files": ["**/*.md"],
"src": "docs",
"dest": "articles",
"exclude": ["**/includes/**"]
"exclude": ["**/includes/**", "***/contributing.md"]
},
{
"files": ["*.md"],
Expand Down
53 changes: 53 additions & 0 deletions docs/current-1.1/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Using the current-1.1 folder and sub-folders
Copy link
Contributor

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?

Copy link
Member Author

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.

Copy link
Contributor

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.


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.

4 changes: 4 additions & 0 deletions docs/includes/warning.md
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)