Skip to content

Commit 62812b6

Browse files
jaredcnancejaredcnance
committed
update docs
1 parent 2547678 commit 62812b6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1990
-115
lines changed

‎JsonApiDotnetCore.sln

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ResourceEntitySeparationExa
4545
EndProject
4646
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ResourceEntitySeparationExampleTests", "test\ResourceEntitySeparationExampleTests\ResourceEntitySeparationExampleTests.csproj", "{6DFA30D7-1679-4333-9779-6FB678E48EF5}"
4747
EndProject
48-
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GettingStarted", "src\Examples\GettingStarted\GettingStarted.csproj", "{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}"
48+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GettingStarted", "src\Examples\GettingStarted\GettingStarted.csproj", "{DF9BFD82-D937-4907-B0B4-64670417115F}"
4949
EndProject
5050
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DiscoveryTests", "test\DiscoveryTests\DiscoveryTests.csproj", "{09C0C8D8-B721-4955-8889-55CB149C3B5C}"
5151
EndProject
@@ -190,19 +190,7 @@ Global
190190
{6DFA30D7-1679-4333-9779-6FB678E48EF5}.Release|x64.ActiveCfg = Release|Any CPU
191191
{6DFA30D7-1679-4333-9779-6FB678E48EF5}.Release|x64.Build.0 = Release|Any CPU
192192
{6DFA30D7-1679-4333-9779-6FB678E48EF5}.Release|x86.ActiveCfg = Release|Any CPU
193-
{6DFA30D7-1679-4333-9779-6FB678E48EF5}.Release|x86.Build.0 = Release|Any CPU
194-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
195-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|Any CPU.Build.0 = Debug|Any CPU
196-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|x64.ActiveCfg = Debug|Any CPU
197-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|x64.Build.0 = Debug|Any CPU
198-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|x86.ActiveCfg = Debug|Any CPU
199-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Debug|x86.Build.0 = Debug|Any CPU
200-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|Any CPU.ActiveCfg = Release|Any CPU
201-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|Any CPU.Build.0 = Release|Any CPU
202-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|x64.ActiveCfg = Release|Any CPU
203-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|x64.Build.0 = Release|Any CPU
204-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|x86.ActiveCfg = Release|Any CPU
205-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71}.Release|x86.Build.0 = Release|Any CPU
193+
{6DFA30D7-1679-4333-9779-6FB678E48EF5}.Release|x86.Build.0 = Release|Any CPU\
206194
{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
207195
{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|Any CPU.Build.0 = Debug|Any CPU
208196
{09C0C8D8-B721-4955-8889-55CB149C3B5C}.Debug|x64.ActiveCfg = Debug|Any CPU
@@ -233,7 +221,6 @@ Global
233221
{9CD2C116-D133-4FE4-97DA-A9FEAFF045F1} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
234222
{F4097194-9415-418A-AB4E-315C5D5466AF} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
235223
{6DFA30D7-1679-4333-9779-6FB678E48EF5} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
236-
{9B2A5AD7-0BF4-472E-A1B4-8BB623FDEB71} = {026FBC6C-AF76-4568-9B87-EC73457899FD}
237224
{09C0C8D8-B721-4955-8889-55CB149C3B5C} = {24B15015-62E5-42E1-9BA0-ECE6BE7AA15F}
238225
EndGlobalSection
239226
GlobalSection(ExtensibilityGlobals) = postSolution

‎docs/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
_site/
2+
*.manifest

‎docs/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Running
2+
3+
```
4+
./generate.sh
5+
docfx ./docfx.json --serve
6+
```

‎docs/api/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
###############
2+
# temp file #
3+
###############
4+
*.yml

‎src/JsonApiDotNetCore/api/.manifest renamed to ‎docs/api/.manifest

Lines changed: 205 additions & 74 deletions
Large diffs are not rendered by default.

‎src/JsonApiDotNetCore/api/index.md renamed to ‎docs/api/index.md

File renamed without changes.

‎src/JsonApiDotNetCore/docfx.json renamed to ‎docs/docfx.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
{
44
"src": [
55
{
6-
"files": [ "**.csproj" ],
7-
"src": "C:\\Users\\jnance\\dev\\json-api-dotnet-core\\src\\JsonApiDotNetCore"
6+
"files": [ "**/JsonApiDotNetCore.csproj" ],
7+
"src": "../"
88
}
99
],
1010
"dest": "api",
@@ -21,8 +21,10 @@
2121
},
2222
{
2323
"files": [
24-
"articles/**.md",
25-
"articles/**/toc.yml",
24+
"getting-started/**.md",
25+
"getting-started/**/toc.yml",
26+
"usage/**.md",
27+
"request-examples/**.md",
2628
"toc.yml",
2729
"*.md"
2830
]

‎docs/generate.sh

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
#!/bin/bash
2+
# generates ./request-examples documents
3+
4+
function cleanup() {
5+
kill -9 $(lsof -ti tcp:5001) &2>/dev/null
6+
}
7+
8+
cleanup
9+
dotnet run -p ../src/Examples/GettingStarted/GettingStarted.csproj &
10+
app_pid=$!
11+
echo "Started app with PID $app_pid"
12+
13+
rm -rf ./request-examples/*.json
14+
rm -rf ./request-examples/*.temp
15+
16+
{ # try
17+
sleep 10
18+
19+
echo "sleep over"
20+
21+
for path in ./request-examples/*.sh; do
22+
op_name=$(basename "$path" .sh)
23+
file="./request-examples/$op_name-Response.json"
24+
temp_file="./request-examples/$op_name-Response.temp"
25+
26+
# 1. execute bash script
27+
# 2. redirect stdout to a temp file, this will be the JSON output
28+
# 3. redirect stderr to JSON file, this will be the curl verbose output
29+
# we grab the last line, trim the prefix, add some newlines and the push
30+
# it to the top of the JSON file
31+
bash $path \
32+
1> >(jq . > $temp_file) \
33+
2> >(grep "HTTP" | tail -n 1 | cut -c 3- | awk '{ printf "%s\n\n",$0 }' > "./request-examples/$op_name-Response.json")
34+
35+
# append the actual JSON to the file
36+
cat $temp_file >> $file
37+
rm $temp_file
38+
done
39+
}
40+
41+
# docfx metadata
42+
43+
cleanup

‎docs/generators/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Installing
2+
3+
...
4+
5+
## Creating a project template
6+
7+
```
8+
dotnet new jadnc
9+
```

‎docs/getting-started/install.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Installation
2+
3+
Click [here](https://www.nuget.org/packages/JsonApiDotnetCore/) for the latest NuGet version.
4+
5+
```
6+
dotnet add package JsonApiDotnetCore
7+
```
8+
9+
```powershell
10+
Install-Package JsonApiDotnetCore
11+
```
12+
13+
```xml
14+
<ItemGroup>
15+
<!-- Be sure to check NuGet for the latest version # -->
16+
<PackageReference Include="JsonApiDotNetCore" Version="3.0.0" />
17+
</ItemGroup>
18+
```
19+
20+
## Pre-Release Packages
21+
22+
Occasionally we will release experimental features as pre-release packages on our
23+
MyGet feed. You can download these by adding [the pacakge feed](https://www.myget.org/feed/Details/research-institute) to your nuget configuration.
24+
25+
These releases are deployed from the `develop` branch directly.
26+
27+
```xml
28+
<?xml version="1.0" encoding="utf-8"?>
29+
<configuration>
30+
<packageSources>
31+
<add key="JADNC Pre-Release" value="https://www.myget.org/F/research-institute/api/v3/index.json" />
32+
</packageSources>
33+
</configuration>
34+
```

0 commit comments

Comments
 (0)