Skip to content

Commit ac51376

Browse files
BillWagnerBillWagner
authored
Update readme for split (#4847)
* udpate github assets for split Reviewed the following files: - [x] Readme.md - [x] Contributing.md was created and points to the docs repo. - [x] Code_of_conduct.md was created and follows the docs repo. - [x] .gitignore Created for samples and projects. - [x] .github folder: created pull request template and codeowners file based on docs repository. * update per feedback See comments on #4846 * change repo list to a list. Also, add the roslyn-api-docs.
1 parent 825ebf8 commit ac51376

File tree

4 files changed

+18
-230
lines changed

4 files changed

+18
-230
lines changed

‎.github/CODEOWNERS‎

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,3 @@
6161
# .NET base types - Formatting
6262
/docs/standard/base-types/formatting-types/** @rpetrusha
6363

64-
########### SAMPLES ################
65-
# C# samples:
66-
/samples/csharp/** @BillWagner
67-
68-
#### Snippets (under samples)
69-
# C++ snippets
70-
/samples/snippets/cpp/** @rpetrusha
71-
# C# Snippets:
72-
/samples/snippets/csharp/** @BillWagner
73-
# Visual Basic snippets:
74-
/samples/snippets/visualbasic/** @rpetrusha

‎.gitignore‎

Lines changed: 0 additions & 202 deletions
Original file line numberDiff line numberDiff line change
@@ -3,214 +3,12 @@ docs/_build/
33
*.swp
44
rebuild.cmd
55

6-
## Ignore Visual Studio temporary files, build results, and
7-
## files generated by popular Visual Studio add-ons.
8-
9-
# User-specific files
10-
*.suo
11-
*.user
12-
*.userosscache
13-
*.sln.docstates
14-
15-
# User-specific files (MonoDevelop/Xamarin Studio)
16-
*.userprefs
17-
18-
# Build results
19-
[Dd]ebug/
20-
[Dd]ebugPublic/
21-
[Rr]elease/
22-
[Rr]eleases/
23-
x64/
24-
x86/
25-
build/
26-
!/docs/core/build/
27-
bld/
28-
[Bb]in/
29-
[Oo]bj/
30-
31-
# Visual Studo 2015 cache/options directory
32-
.vs/
33-
34-
# MSTest test Results
35-
[Tt]est[Rr]esult*/
36-
[Bb]uild[Ll]og.*
37-
38-
# NUNIT
39-
*.VisualState.xml
40-
TestResult.xml
41-
42-
# Build Results of an ATL Project
43-
[Dd]ebugPS/
44-
[Rr]eleasePS/
45-
dlldata.c
46-
47-
*_i.c
48-
*_p.c
49-
*_i.h
50-
*.ilk
51-
*.meta
52-
*.obj
53-
*.pch
54-
*.pdb
55-
*.pgc
56-
*.pgd
57-
*.rsp
58-
*.sbr
59-
*.tlb
60-
*.tli
61-
*.tlh
62-
*.tmp
63-
*.tmp_proj
64-
*.log
65-
*.vspscc
66-
*.vssscc
67-
.builds
68-
*.pidb
69-
*.svclog
70-
*.scc
71-
72-
# Chutzpah Test files
73-
_Chutzpah*
74-
75-
# Visual C++ cache files
76-
ipch/
77-
*.aps
78-
*.ncb
79-
*.opensdf
80-
*.sdf
81-
*.cachefile
82-
83-
# Visual Studio profiler
84-
*.psess
85-
*.vsp
86-
*.vspx
87-
88-
# TFS 2012 Local Workspace
89-
$tf/
90-
91-
# Guidance Automation Toolkit
92-
*.gpState
93-
94-
# ReSharper is a .NET coding add-in
95-
_ReSharper*/
96-
*.[Rr]e[Ss]harper
97-
*.DotSettings.user
98-
99-
# JustCode is a .NET coding addin-in
100-
.JustCode
101-
102-
# TeamCity is a build add-in
103-
_TeamCity*
104-
105-
# DotCover is a Code Coverage Tool
106-
*.dotCover
107-
108-
# NCrunch
109-
_NCrunch_*
110-
.*crunch*.local.xml
111-
112-
# MightyMoose
113-
*.mm.*
114-
AutoTest.Net/
115-
116-
# Web workbench (sass)
117-
.sass-cache/
118-
119-
# Installshield output folder
120-
[Ee]xpress/
121-
122-
# DocProject is a documentation generator add-in
123-
DocProject/buildhelp/
124-
DocProject/Help/*.HxT
125-
DocProject/Help/*.HxC
126-
DocProject/Help/*.hhc
127-
DocProject/Help/*.hhk
128-
DocProject/Help/*.hhp
129-
DocProject/Help/Html2
130-
DocProject/Help/html
131-
132-
# Click-Once directory
133-
publish/
134-
135-
# Publish Web Output
136-
*.[Pp]ublish.xml
137-
*.azurePubxml
138-
# TODO: Comment the next line if you want to checkin your web deploy settings
139-
# but database connection strings (with potential passwords) will be unencrypted
140-
*.pubxml
141-
*.publishproj
142-
143-
# NuGet Packages
144-
*.nupkg
145-
# The packages folder can be ignored because of Package Restore
146-
**/packages/*
147-
# except build/, which is used as an MSBuild target.
148-
!**/packages/build/
149-
# Uncomment if necessary however generally it will be regenerated when needed
150-
#!**/packages/repositories.config
151-
152-
# Windows Azure Build Output
153-
csx/
154-
*.build.csdef
155-
156-
# Windows Store app package directory
157-
AppPackages/
158-
159-
# Others
160-
*.[Cc]ache
161-
ClientBin/
162-
[Ss]tyle[Cc]op.*
163-
~$*
164-
*~
165-
*.dbmdl
166-
*.dbproj.schemaview
167-
*.pfx
168-
*.publishsettings
169-
node_modules/
170-
bower_components/
171-
172-
# RIA/Silverlight projects
173-
Generated_Code/
174-
175-
# Backup & report files from converting an old project file
176-
# to a newer Visual Studio version. Backup files are not needed,
177-
# because we have git ;-)
178-
_UpgradeReport_Files/
179-
Backup*/
180-
UpgradeLog*.XML
181-
UpgradeLog*.htm
182-
183-
# SQL Server files
184-
*.mdf
185-
*.ldf
186-
1876
# Business Intelligence projects
1887
*.rdl.data
1898
*.bim.layout
1909
*.bim_*.settings
19110

192-
# Microsoft Fakes
193-
FakesAssemblies/
194-
195-
# Node.js Tools for Visual Studio
196-
.ntvs_analysis.dat
197-
198-
# Visual Studio 6 build log
199-
*.plg
200-
201-
# Visual Studio 6 workspace options file
202-
*.opt
203-
204-
samples/MigratingFromMvc5/NewMvc6Project/src/NewMvc6Project/wwwroot/lib/
205-
samples/AngularSample/src/AngularSample/wwwroot/lib
206-
project.lock.json
207-
samples/WebApplication1/src/WebApplication1/wwwroot/lib/
208-
209-
/samples/core/linq/csharp/aggregate/*.xproj
210-
/samples/core/linq/csharp/aggregate/*.sln
211-
21211
_site/
213-
api_src/
21412
api/
21513
_themes/
21614
_themes.pdf/

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ The document covers the process for contributing to the articles and code sample
99
* [Building the docs](#building-the-docs)
1010
* [Contributor License Agreement](#contributor-license-agreement)
1111

12+
This repository contains the conceptual documentation for .NET. The .NET documentation site is built from multiple repositories in addition to this one:
13+
14+
- [Code samples and snippets](https://github.com/dotnet/samples)
15+
- [API reference](https://github.com/dotnet/dotnet-api-docs)
16+
- [.NET Compiler Platform SDK reference](https://github.com/dotnet/roslyn-api-docs)
17+
18+
Issues and tasks for all these repositories are tracked here.
19+
1220
## Process for contributing
1321

1422
You need a basic understanding of [Git and GitHub.com](https://guides.github.com/activities/hello-world/).
@@ -28,7 +36,7 @@ You can also choose from existing issues for which community contributions are w
2836

2937
You can also look at our [open issues](https://github.com/dotnet/docs/issues) list and volunteer to work on the ones you're interested in. We use the [up-for-grabs](https://github.com/dotnet/docs/labels/up-for-grabs) label to tag issues open for contribution.
3038

31-
**Step 2:** Fork the `/dotnet/docs` repo and create a branch for your changes.
39+
**Step 2:** Fork the `/dotnet/docs`, `dotnet/samples` or `dotnet/dotnet-api-docs` repos as needed and create a branch for your changes.
3240

3341
For small changes, you can use GitHub's web interface. Simply click the **Edit the file in your fork of this project** on the file you'd like to change.
3442
GitHub creates the new branch for you when you submit the changes.
@@ -45,8 +53,6 @@ Include larger samples in the *samples* folder under the root of the repo.
4553

4654
Be sure to follow the proper Markdown syntax. For more information, see the [style guide](./styleguide/template.md).
4755

48-
Remove the "wrench" icon (🔧) from the TOC and the file heading, if applicable.
49-
5056
### Example structure
5157

5258
docs
@@ -57,11 +63,6 @@ Remove the "wrench" icon (🔧) from the TOC and the file heading, if applicable
5763
/media
5864
/porting-overview
5965
portability_report.png
60-
...
61-
samples
62-
/core
63-
/porting
64-
porting_sample.cs
6566

6667
**Step 4:** Submit a Pull Request (PR) from your branch to `dotnet/docs/master`.
6768

@@ -85,7 +86,7 @@ We make the following distinction for code that exists in our repository:
8586

8687
- snippets: illustrate a smaller concept or task. They compile but they are not intended to be complete applications.
8788

88-
Code all lives in the *samples* directories and is organized as follows:
89+
Code all lives in the [dotnet/samples](https://github.com/dotnet/samples) repository and is organized as follows:
8990

9091
- *core* contains .NET Core samples.
9192

‎README.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ This repo contains work-in-progress documentation for .NET. To contribute, see t
44

55
We welcome contributions to help us improve and complete the .NET docs. We anticipate that [Xamarin](http://developer.xamarin.com/api/root/classlib/), [Mono](http://docs.go-mono.com/?link=root%3a%2fclasslib) and [Unity](http://docs.unity3d.com/Manual/index.html) will also use this documentation.
66

7+
This repository contains the conceptual documentation for .NET. The .NET documentation site is built from multiple repositories in addition to this one:
8+
9+
- [Code samples and snippets](https://github.com/dotnet/samples)
10+
- [API reference](https://github.com/dotnet/dotnet-api-docs)
11+
- [.NET Compiler Platform SDK reference](https://github.com/dotnet/roslyn-api-docs)
12+
13+
Issues and tasks for all three of those repositories are tracked here.
14+
715
This project has adopted the code of conduct defined by the Contributor Covenant
816
to clarify expected behavior in our community.
917
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
10-
11-
Samples Build Status
12-
===
13-
14-
| Samples | Ubuntu 16.04<br/>_.NET Core 1.1.0_ | Ubuntu 16.04<br/>_.NET Core 2.0.0_ |
15-
| ------------- |------------| -----|
16-
| `/samples/core` | ![](https://constructors.visualstudio.com/_apis/public/build/definitions/3186585f-1677-4c9e-a8b2-baac48a4032a/56/badge)| ![](https://constructors.visualstudio.com/_apis/public/build/definitions/3186585f-1677-4c9e-a8b2-baac48a4032a/57/badge) |
17-
|`/samples/csharp`| ![](https://constructors.visualstudio.com/_apis/public/build/definitions/3186585f-1677-4c9e-a8b2-baac48a4032a/54/badge)| ![](https://constructors.visualstudio.com/_apis/public/build/definitions/3186585f-1677-4c9e-a8b2-baac48a4032a/55/badge) |

0 commit comments

Comments
 (0)