Skip to content

Commit 4e4d9c4

Browse files
committed
Update intro page
1 parent e9c469e commit 4e4d9c4

File tree

3 files changed

+38
-32
lines changed

3 files changed

+38
-32
lines changed

docs/Hosted-Service-Onboarding.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,17 @@ Some important aspects of the hosted service to consider:
2929

3030
### Environments
3131

32-
- As part of your development workflow, ensure your application is using the correct COMS environment. COMS only accepts JWT's issued in the corresponding SSO `standard` realm.
32+
As part of your development workflow, ensure your application is using the correct COMS environment. **The Hosted COMS service only accepts User Auth tokens issued in the corresponding SSO 'Standard' realm.**
3333

34-
COMS environments:
35-
- Development: [https://coms-dev.api.gov.bc.ca/api/v1/](https://coms.api.gov.bc.ca/api/v1/)
36-
- Test: [https://coms-test.api.gov.bc.ca/api/v1/](https://coms.api.gov.bc.ca/api/v1/)
37-
- Production: [https://coms.api.gov.bc.ca/api/v1/](https://coms.api.gov.bc.ca/api/v1/)
34+
COMS environments:
35+
36+
- Development: [https://coms-dev.api.gov.bc.ca/api/v1/](https://coms.api.gov.bc.ca/api/v1/)
37+
38+
- Test: [https://coms-test.api.gov.bc.ca/api/v1/](https://coms.api.gov.bc.ca/api/v1/)
39+
40+
- Production: [https://coms.api.gov.bc.ca/api/v1/](https://coms.api.gov.bc.ca/api/v1/)
3841
<br /><br />
42+
3943
***
4044
<br />
4145

docs/index.md

Lines changed: 20 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,34 @@
11
# Common Object Management Service
22

3-
A microservice for managing access control to S3 Objects
3+
A microservice for managing access control to files in S3-compatible Object Storage
44

5-
## Wiki Contents
5+
Take advantage of more cost-effective storage solutions for your new or existing business applications. Common Object Management Service (COMS) is a secure REST API that lets you connect your application to an S3 bucket. In S3, you can store and share files, images, and documents with co-workers, partners, or the public.
66

7-
**API User Guide:**
7+
## Onboarding Options
88

9-
- [Authentication](Authentication.md)
10-
- [Endpoint Notes](Endpoint-Notes.md)
11-
- [Permissions](Permissions.md)
12-
- [Metadata and Tags](Metadata-Tag.md)
13-
- [Managing buckets](Buckets.md)
14-
- [Synchronization](Synchronization.md)
15-
- [Use-Case Examples](Use-Case-Examples.md)
9+
COMS is now available as a shared hosted service as well as an application that you can customise and deploy in your own infrastructure. See documentation on [Hosting Considerations](Hosting-Considerations.md).
1610

17-
**Deployment Guide:**<br />
18-
Install COMS in your own environment for extra features
11+
We have also launched [BCBox](https://bcbox.nrs.gov.bc.ca), a DropBox-like user-interface for managing files, integrated with the hosted COMS service.
1912

20-
- [Self-Hosting COMS](Self-Hosting-COMS.md)
21-
- [Architecture](Architecture.md)
22-
- [Database](Architecture.md#database-structure)
23-
- [Code Design](Architecture.md#code-design)
24-
- [Configuration Options](Configuration.md)
25-
- [Testing](Testing.md)
13+
## Feature List
2614

27-
**The Hosted Service:**<br />
28-
Find out if the BC Gov Hosted COMS service will work for you?
15+
- Upload, download, manage and delete files
16+
- Manage file versions and soft-deletes
17+
- Enable general public access to files
18+
- Grant permissions on buckets and files to authenticated users (eg IDIR or BCeID)
19+
- Share and invite users to work with your files
20+
- Manage metadata and tags on objects
21+
- Flexible search and filter capabilities based on objects attributes and user permissions
22+
- Sync COMS with files that already exist in your bucket
2923

30-
- [Hosted Service Onboarding](Hosted-Service-Onboarding.md)
31-
- [Hosting Considerations](Hosting-Considerations.md)
32-
- [Hosted Service Architecture](Architecture-Hosted.md)
24+
## Product Reference
3325

26+
Please follow the links in the side menu to learn more about COMS.
3427

35-
<br />
28+
- Hosted COMS service URL: [https://coms.api.gov.bc.ca](https://coms.api.gov.bc.ca)
29+
- GitHub Repository: [https://github.com/bcgov/common-object-management-service/](https://github.com/bcgov/common-object-management-service/)
30+
- API Specification: [https://coms.api.gov.bc.ca/api/v1/docs](https://coms.api.gov.bc.ca/api/v1/docs)
31+
- UI Integration: [BCBox](https://bcbox.nrs.gov.bc.ca)
3632

3733
**[Product Roadmap](Product-Roadmap.md)**
3834

mkdocs.yml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ plugins:
88
- git-revision-date-localized
99
markdown_extensions:
1010
- md_in_html
11+
- toc:
12+
permalink: "#"
1113
nav:
12-
- Contents: index.md
14+
- Introduction: index.md
1315
- API User Guide:
1416
- Authentication: Authentication.md
1517
- Endpoint Notes: Endpoint-Notes.md
@@ -20,10 +22,14 @@ nav:
2022
- Use-Case Examples: Use-Case-Examples.md
2123
- Deployment Guide:
2224
- Self-Hosting COMS: Self-Hosting-COMS.md
23-
- Architecture: Architecture.md
25+
- Architecture:
26+
- Overview: Architecture.md
27+
- Database: Architecture/#database-structure
28+
- Code Design: Architecture/#code-design
2429
- Configuration Options: Configuration.md
2530
- Testing: Testing.md
2631
- The Hosted Service:
2732
- Hosting Considerations: Hosting-Considerations.md
2833
- Hosted Service Architecture: Architecture-Hosted.md
29-
- Hosted Service Onboarding: Hosted-Service-Onboarding.md
34+
- Hosted Service Onboarding: Hosted-Service-Onboarding.md
35+
- Product Roadmap: Product-Roadmap.md

0 commit comments

Comments
 (0)