Merge pull request #2562 from spotify/rugvip/api

backend: change the default backend plugin mount point to /api
This commit is contained in:
Patrik Oldsberg
2020-09-24 15:58:12 +02:00
committed by GitHub
22 changed files with 68 additions and 60 deletions
+2 -2
View File
@@ -18,11 +18,11 @@ yarn start
## What techdocs-backend does
This plugin is the backend part of the techdocs plugin. It provides building and serving of your docs without having to use another service and hosting provider. To use it set your techdocs storageUrl in your `app-config.yml` to `http://localhost:7000/techdocs/static/docs`.
This plugin is the backend part of the techdocs plugin. It provides building and serving of your docs without having to use another service and hosting provider. To use it set your techdocs storageUrl in your `app-config.yml` to `http://localhost:7000/api/techdocs/static/docs`.
```yaml
techdocs:
storageUrl: http://localhost:7000/techdocs/static/docs
storageUrl: http://localhost:7000/api/techdocs/static/docs
```
## Extending techdocs-backend
@@ -64,7 +64,7 @@ export class LocalPublish implements PublisherBase {
}
resolve({
remoteUrl: `http://localhost:7000/techdocs/static/docs/${entity.metadata.name}`,
remoteUrl: `http://localhost:7000/api/techdocs/static/docs/${entity.metadata.name}`,
});
});
});