Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Commit 3547fe7

Browse files
jimmyjaypjimmyjayp
committed
Moving readme docs to their new - standard - home
1 parent 612ceea commit 3547fe7

File tree

14 files changed

+66
-43
lines changed

14 files changed

+66
-43
lines changed

‎api_server/docs/README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# API Documentation Library
2+
3+
- [Integrations and OAuth](integrations.md) - OAuth integration flow overview
4+
- [RabbitMQ Notes](rabbitmq.md)
5+
- [Version Compatibility Matrix](version-matrix.md)
6+
- [Unified Config File](unified-cfg-file.md) - Details on the unified structured config file used for backend services.
7+
- [TeamCity build information](build.md)
8+
- [On-Prem Development](onprem-development.md) - Setting up a sandbox for onprem development.
9+
- [Pubnub Access](pubnub.md)

api_server/README.build.md renamed to api_server/docs/build.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API Server Build Information
22

3-
TeamCity Project: [API](http://tc.codestream.us/project/Api)
3+
TeamCity Project: [API](http://redirector.codestream.us/builds/api)
44

55
## GitFlow and Brief Overview
66
Read the [Build Overview](https://teamcodestream.atlassian.net/wiki/x/04BID) page on the Ops Wiki site.
@@ -18,6 +18,6 @@ Read the [Build Overview](https://teamcodestream.atlassian.net/wiki/x/04BID) pag
1818
| prod | tgz | [Asset server (prod/api-server)](http://assets.codestream.us/artifacts/prod/api-server/) |
1919
| onprem | docker image | Published to docker hub as [teamcodestream/api-onprem](https://cloud.docker.com/u/teamcodestream/repository/docker/teamcodestream/api-onprem) |
2020

21-
## Builds
21+
## Build Documentation
2222

23-
[see standard builds](https://github.com/TeamCodeStream/teamcity_tools/blob/master/README.project-build-types.md#standard-project-builds)
23+
[TeamCity build documentation](https://github.com/TeamCodeStream/teamcity_tools/tree/master/docs)

api_server/README.integrations.md renamed to api_server/docs/integrations.md

File renamed without changes.

api_server/README.onprem-development.md renamed to api_server/docs/onprem-development.md

File renamed without changes.

api_server/README.pubnub renamed to api_server/docs/pubnub.md

File renamed without changes.

api_server/README.rabbitmq renamed to api_server/docs/rabbitmq.md

File renamed without changes.

api_server/README.unified-cfg-file.md renamed to api_server/docs/unified-cfg-file.md

File renamed without changes.

api_server/README.version-matrix.md renamed to api_server/docs/version-matrix.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -29,34 +29,36 @@ For each extension, these fields are maintained:
2929
Currently, the version matrix is stored in a json file in the api server repo:
3030
**api_server/etc/version_matrix.json**. It looks like this:
3131

32-
{\
33-
"_id" : ObjectId("5b8082701a3a5d2711f0fc57"),\
34-
"clientType" : "VS Code",\
35-
"currentRelease" : "7.4.1",\
36-
"minimumPreferredRelease" : "7.3.0",\
37-
"earliestSupportedRelease" : "7.0.0"\
38-
}\
39-
{\
40-
"_id" : ObjectId("5d83a95d970e5f999a86139a"),\
41-
"clientType" : "VS",\
42-
"currentRelease" : "7.4.1",\
43-
"minimumPreferredRelease" : "7.3.0",\
44-
"earliestSupportedRelease" : "7.0.0"\
45-
}\
46-
{\
47-
"_id" : ObjectId("5d83a966970e5f999a86139b"),\
48-
"clientType" : "JetBrains",\
49-
"currentRelease" : "7.4.1",\
50-
"minimumPreferredRelease" : "7.3.0",\
51-
"earliestSupportedRelease" : "7.0.0"\
52-
}\
53-
{\
54-
"_id" : ObjectId("5d83a96c970e5f999a86139c"),\
55-
"clientType" : "Atom",\
56-
"currentRelease" : "7.4.1",\
57-
"minimumPreferredRelease" : "7.3.0",\
58-
"earliestSupportedRelease" : "7.0.0"\
59-
}\
32+
```
33+
{
34+
"_id" : ObjectId("5b8082701a3a5d2711f0fc57"),
35+
"clientType" : "VS Code",
36+
"currentRelease" : "7.4.1",
37+
"minimumPreferredRelease" : "7.3.0",
38+
"earliestSupportedRelease" : "7.0.0"
39+
},
40+
{
41+
"_id" : ObjectId("5d83a95d970e5f999a86139a"),
42+
"clientType" : "VS",
43+
"currentRelease" : "7.4.1",
44+
"minimumPreferredRelease" : "7.3.0",
45+
"earliestSupportedRelease" : "7.0.0"
46+
},
47+
{
48+
"_id" : ObjectId("5d83a966970e5f999a86139b"),
49+
"clientType" : "JetBrains",
50+
"currentRelease" : "7.4.1",
51+
"minimumPreferredRelease" : "7.3.0",
52+
"earliestSupportedRelease" : "7.0.0"
53+
},
54+
{
55+
"_id" : ObjectId("5d83a96c970e5f999a86139c"),
56+
"clientType" : "Atom",
57+
"currentRelease" : "7.4.1",
58+
"minimumPreferredRelease" : "7.3.0",
59+
"earliestSupportedRelease" : "7.0.0"
60+
}
61+
```
6062

6163
**clientType** refers to the extension type (IDE) for the record in question.
6264

‎broadcaster/docs/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Broadcaster Documentation Library
2+
3+
- [TeamCity build information](build.md)

broadcaster/README.build.md renamed to broadcaster/docs/build.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Broadcaster Build Information
22

3-
TeamCity Project: [Broadcaster](http://tc.codestream.us/project/Broadcaster)
3+
TeamCity Project: [Broadcaster](https://redirector.codestream.us/builds/broadcaster)
44

55
## GitFlow and Brief Overview
66
Read the [Build Overview](https://teamcodestream.atlassian.net/wiki/x/04BID) page on the Ops Wiki site.
@@ -12,6 +12,6 @@ Read the [Build Overview](https://teamcodestream.atlassian.net/wiki/x/04BID) pag
1212
| dev | tgz | [Asset server (dev/broadcaster)](http://assets.codestream.us/artifacts/dev/api-server/) |
1313
| onprem | docker image | Published to docker hub as [teamcodestream/broadcaster-onprem](https://cloud.docker.com/u/teamcodestream/repository/docker/teamcodestream/broadcaster-onprem) |
1414

15-
## Builds
15+
## Build Documentation
1616

17-
[see standard builds](https://github.com/TeamCodeStream/teamcity_tools/blob/master/README.project-build-types.md#standard-project-builds)
17+
[TeamCity build documentation](https://github.com/TeamCodeStream/teamcity_tools/tree/master/docs)

0 commit comments

Comments
 (0)