|
| 1 | +# Using the current-1.1 folder and sub-folders |
| 2 | + |
| 3 | +This folder is the top-level node that matches the [docs](../welcome.md) |
| 4 | +folder, but contains deltas for the .NET Core 1.1 release. |
| 5 | + |
| 6 | +The goal of this separate parallel folder structure is to provide a location |
| 7 | +for the 1.1 release related content that can be relatively easily merged into |
| 8 | +the main structure when provide version switching in the published site. |
| 9 | + |
| 10 | +The content under this node should be a smaller document set that represents |
| 11 | +the deltas from the Long Term Support (LTS) release and the latest |
| 12 | +current release. |
| 13 | + |
| 14 | +## Structure |
| 15 | + |
| 16 | +There are two cases to adding new content for this release: |
| 17 | + |
| 18 | +* Changes to existing documents |
| 19 | + - 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. |
| 20 | +* New documents |
| 21 | + - Put the new document in the proper location, and add it to the TOC under the node for the 1.1 preview release. |
| 22 | + |
| 23 | +All current release files should have the following added near the |
| 24 | +top of the topic: |
| 25 | + |
| 26 | +[!include[current release track](../includes/warning.md)] |
| 27 | + |
| 28 | +We've created a snippet to include with the following syntax: |
| 29 | + |
| 30 | +```markdown |
| 31 | +[!include[current release track](../includes/warning.md)] |
| 32 | +``` |
| 33 | + |
| 34 | +### Link instructions |
| 35 | + |
| 36 | +In both cases, provide links from current release to the LTS page (or parent index.md) |
| 37 | +for navigational purposes. |
| 38 | +Consider providing links from the LTS page (or parent index.md) to the |
| 39 | +new current release content page. |
| 40 | + |
| 41 | +## Future Considerations |
| 42 | + |
| 43 | +Our end goal is to surface different releases as branches in the |
| 44 | +[docs repo](https://github.com/dotnet/docs). Until that publishing |
| 45 | +scenario is supported, we'll use different top-level folders for each |
| 46 | +current release. |
| 47 | + |
| 48 | +When the time comes, we can merge each current release into the main |
| 49 | +[docs](../docs) folder, merge the TOC nodes, and publish as a separate doc |
| 50 | +set. We may need to merge modifications to both the LTS version of a file |
| 51 | +and the current release of a file, but we should be able to find those |
| 52 | +changes relatively easily. |
| 53 | + |
0 commit comments