Skip to content

Commit 62d44aa

Browse files
author
Maksym Mykhailenko
committed
docs: small improvements
1 parent 54edba3 commit 62d44aa

File tree

3 files changed

+27
-28
lines changed

3 files changed

+27
-28
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,24 @@ Microservice to manage CRUD operations for all things Projects.
44

55
**Note: Steps mentioned below are best to our capability as guide for local deployment, however, we expect from contributor, being a developer, to resolve run-time issues (e.g. OS and node version issues etc), if any.**
66

7-
- [Topcoder Projects Service](#topcoder-projects-service)
8-
- [Local Development](#local-development)
9-
- [Requirements](#requirements)
10-
- [Steps to run locally](#steps-to-run-locally)
11-
- [Run Connect App with Project Service locally](#run-connect-app-with-project-service-locally)
12-
- [Import and Export data](#import-and-export-data)
13-
- [📤 Export data](#%f0%9f%93%a4-export-data)
14-
- [📥 Import data](#%f0%9f%93%a5-import-data)
15-
- [Import metadata from api.topcoder-dev.com (deprecated)](#import-metadata-from-apitopcoder-devcom-deprecated)
16-
- [Run via Docker](#run-via-docker)
17-
- [NPM Commands](#npm-commands)
18-
- [Kafka commands](#kafka-commands)
19-
- [Create Topic](#create-topic)
20-
- [List Topics](#list-topics)
21-
- [Watch Topic](#watch-topic)
22-
- [Post Message to Topic (from stdin)](#post-message-to-topic-from-stdin)
23-
- [Test](#test)
24-
- [JWT Authentication](#jwt-authentication)
25-
- [Documentation](#documentation)
7+
- [Local Development](#local-development)
8+
- [Requirements](#requirements)
9+
- [Steps to run locally](#steps-to-run-locally)
10+
- [Run Connect App with Project Service locally](#run-connect-app-with-project-service-locally)
11+
- [Import and Export data](#import-and-export-data)
12+
- [📤 Export data](#%f0%9f%93%a4-export-data)
13+
- [📥 Import data](#%f0%9f%93%a5-import-data)
14+
- [Import metadata from api.topcoder-dev.com (deprecated)](#import-metadata-from-apitopcoder-devcom-deprecated)
15+
- [Run via Docker](#run-via-docker)
16+
- [NPM Commands](#npm-commands)
17+
- [Kafka commands](#kafka-commands)
18+
- [Create Topic](#create-topic)
19+
- [List Topics](#list-topics)
20+
- [Watch Topic](#watch-topic)
21+
- [Post Message to Topic (from stdin)](#post-message-to-topic-from-stdin)
22+
- [Test](#test)
23+
- [JWT Authentication](#jwt-authentication)
24+
- [Documentation](#documentation)
2625

2726
## Local Development
2827

@@ -353,6 +352,7 @@ It's been signed with the secret 'secret'. This secret should match your entry i
353352

354353
## Documentation
355354

356-
- [Swagger API Definition](http://editor.swagger.io/?url=https://raw.githubusercontent.com/topcoder-platform/tc-project-service/develop/docs/swagger.yaml) - click to open it via Online Swagger Editor.
357-
- [Permissions]() - the list of all permissions in Project Service.
358355
- [Projects Service Architecture](./docs/guides/architercture/architecture.md)
356+
- [Permissions Guide](https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/guides/permissions-guide/permissions-guide.md) - what kind of permissions we have, how they work and how to use them.
357+
- [Permissions](https://htmlpreview.github.io/?https://github.com/topcoder-platform/tc-project-service/blob/develop/docs/permissions.html) - the list of all permissions in Project Service.
358+
- [Swagger API Definition](http://editor.swagger.io/?url=https://raw.githubusercontent.com/topcoder-platform/tc-project-service/develop/docs/swagger.yaml) - click to open it via Online Swagger Editor.

docs/guides/architercture/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,4 +73,4 @@ payload: {
7373
"updatedBy": 1,
7474
},
7575
}
76-
```
76+
```

docs/guides/permissions-guide/permissions-guide.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22

33
What kind of permissions we have, how they work and how to use them.
44

5-
- [Permissions Guide](#permissions-guide)
6-
- [Overview](#overview)
7-
- [Topcoder Roles](#topcoder-roles)
8-
- [Project Role](#project-role)
9-
- [How to Use](#how-to-use)
10-
- [References](#references)
5+
- [Overview](#overview)
6+
- [Topcoder Roles](#topcoder-roles)
7+
- [Project Role](#project-role)
8+
- [How to Use](#how-to-use)
9+
- [References](#references)
1110

1211
## Overview
1312

0 commit comments

Comments
 (0)