forked from dotnet/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
create initial contributing.md for fast releases. (dotnet#1206)
* create initial contributing.md for fast releases. * fix markdown syntax issue. * fix the link to the main docs folder. * one more time, fixing the link. * add note about contributing.md location. * Add any contributing.md files to the exclude list We don’t want them on the live site. * stashing to switch branches. * update the link in the warning include. * update with correct current release terms. * Update for feedback.
- Loading branch information
1 parent
1cb9e19
commit a6b9932
Showing
3 changed files
with
58 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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 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 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) |