Update relative links

Author: TimCsaky

docs/Authentication.md

@@ -1,10 +1,10 @@
-This page describes how to authenticate requests to the COMS API. The [Authentication Modes](Configuration#authentication-modes) must be enabled in the COMS configuration.
+This page describes how to authenticate requests to the COMS API. The [Authentication Modes](Configuration.md#authentication-modes) must be enabled in the COMS configuration.
 
 **Note:** The BC Gov Hosted COMS service only allows OIDC Authentication using JWT's issued by the [Pathfinder SSO `standard` keycloak realm](https://github.com/bcgov/sso-keycloak/wiki#standard-service)).
 
 ## OIDC Authentication
 
-With [OIDC mode](Configuration#oidc-keycloak) enabled, requests to the COMS API can be authenticated using a **User ID token** (JWT) issued by an OIDC authentication realm. The JWT should be added in an Authorization header (type `Bearer` token).
+With [OIDC mode](Configuration.md#oidc-keycloak) enabled, requests to the COMS API can be authenticated using a **User ID token** (JWT) issued by an OIDC authentication realm. The JWT should be added in an Authorization header (type `Bearer` token).
 
 COMS will only accept JWT's issued by one OIDC realm (specified in the COMS config). JWT's are typically issued to an application and saved to a user's browser when he/she signs-in to a website through the [Authorization Code Flow](https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth). Both the website (client app) and the instance of COMS must be [configured to use the same OIDC authentication realm](https://github.com/bcgov/common-object-management-service/blob/master/app/README.md#keycloak-variables) in order for the JWT to be valid.
 
@@ -31,12 +31,12 @@ COMS uses the redirect flow by default because it avoids unnecessary network hop
 
 ## Basic Auth
 
-If [Basic Auth Mode](Configuration#basic-auth) is enabled in your COMS instance, requests to the COMS API can be authenticated using an HTTP Authorization header (type `Basic`) containing the username and password configured in COMS.
+If [Basic Auth Mode](Configuration.md#basic-auth) is enabled in your COMS instance, requests to the COMS API can be authenticated using an HTTP Authorization header (type `Basic`) containing the username and password configured in COMS.
 
 This mode offers more direct access for a 'service account' authorized in the scope of the application rather than for a specific user and by-passes the COMS object/bucket permission model.
 
 Basic Auth mode is not available on the BC Gov hosted COMS service.
 
 ## Unauthenticated Mode
 
-[Unauthenticated Mode](Configuration#unauthenticated-auth) configuration is generally recommended when you expect to run COMS in a highly secured network environment and do not have concerns about access control to objects as you have another application handling that already.
+[Unauthenticated Mode](Configuration.md#unauthenticated-auth) configuration is generally recommended when you expect to run COMS in a highly secured network environment and do not have concerns about access control to objects as you have another application handling that already.

docs/Buckets.md

@@ -1,13 +1,13 @@
 
 ### Configuring Buckets
 
-- COMS is [configured with a 'default' bucket](Configuration#object-storage). Various object management endpoints will use this bucket if no `bucketId` parameter is provided. (**Note:** the default bucket fall-back behaviour is not available in the BC Gov Hosted COMS service.)
+- COMS is [configured with a 'default' bucket](Configuration.md#object-storage). Various object management endpoints will use this bucket if no `bucketId` parameter is provided. (**Note:** the default bucket fall-back behaviour is not available in the BC Gov Hosted COMS service.)
 
 - Additional buckets can be added to the COMS system using the [createBucket](https://coms.api.gov.bc.ca/api/v1/docs#tag/Bucket/operation/createBucket) endpoint.
 
-- When a bucket is created, if the createBucket API request is authenticated with a User ID token (JWT), that user will be granted all [5 permissions](Permissions#permission-codes). Bucket Permissions can be granted to other users ([bucketAddPermissions](https://coms.api.gov.bc.ca/api/v1/docs#tag/Permission/operation/bucketAddPermissions)), if the request is authenticated with a JWT for a user with `MANAGE` permission.
+- When a bucket is created, if the createBucket API request is authenticated with a User ID token (JWT), that user will be granted all [5 permissions](Permissions.md#permission-codes). Bucket Permissions can be granted to other users ([bucketAddPermissions](https://coms.api.gov.bc.ca/api/v1/docs#tag/Permission/operation/bucketAddPermissions)), if the request is authenticated with a JWT for a user with `MANAGE` permission.
 
-If you are self-hosting COMS you can also manage permissions for any object or bucket by using these endpoints with [basic authentication](Authentication#basic-auth).
+If you are self-hosting COMS you can also manage permissions for any object or bucket by using these endpoints with [basic authentication](Authentication.md#basic-auth).
 
 ### Using the Bucket **Key**
 

docs/Endpoint-Notes.md

@@ -35,13 +35,13 @@ Object endpoints directly influence and manipulate S3 objects and information in
 
 Metadata operation endpoints directly focus on the manipulation of metadata of S3 Objects. Each endpoint will create a copy of the object with the modified metadata attached.
 
-More details found here: [Metadata and Tags](Metadata-Tag)
+More details found here: [Metadata and Tags](Metadata-Tag.md)
 
 ### Tag
 
 Tag operation endpoints directly focus on the manipulation of tags of S3 Objects. Unlike Metadata, Tags can be modified without the need to create new versions of the object.
 
-More details found here: [Metadata and Tags](Metadata-Tag)
+More details found here: [Metadata and Tags](Metadata-Tag.md)
 
 ### Versions
 
@@ -51,7 +51,7 @@ Version specific operations focus on listing and discovering versioning informat
 
 Permission operation endpoints directly focus on associating users to objects with specific permissions. All of these endpoints require a database to function. Existing permissions can be searched for using `GET /permission/object` and `GET /permission/bucket`, and standard create, read and delete operations for permissions exist to allow users to modify access control for specific objects they have management permissions over.
 
-More details found here: [Permissions](Permissions)
+More details found here: [Permissions](Permissions.md)
 
 ## Sync
 

docs/Hosted-Service-Onboarding.md

@@ -13,19 +13,19 @@ Some important aspects of the hosted service to consider:
 
 - Object Storage buckets must be obtained by the client. Any S3 compatible bucket will work (for example: AWS S3 and Minio). OCIO provide a low-cost [object Storage service](https://ssbc-client.gov.bc.ca/services/ObjectStorage/overview.htm). NRM clients can request a bucket through the [Optimization Team](https://apps.nrs.gov.bc.ca/int/confluence/display/OPTIMIZE/NRM+Object+Storage+Service).
 
-- Once provisioned, you can add your bucket to COMS using the [createBucket](https://coms.api.gov.bc.ca/api/v1/docs#tag/Bucket/operation/createBucket) endpoint. See: [Managing Buckets](Buckets).
+- Once provisioned, you can add your bucket to COMS using the [createBucket](https://coms.api.gov.bc.ca/api/v1/docs#tag/Bucket/operation/createBucket) endpoint. See: [Managing Buckets](Buckets.md).
 
 - **Bucket credentials** (`Access Key ID` and `Secret Access Key`) are stored in the database as encrypted strings. Encryption is done by NodeJS's internal `crypto` library. The key for encryption is assigned to a `SERVER_PASSPHRASE` environment variable, and is only available inside the scope of the COMS app container.
 
 ### Privacy Controls
 
-- The stricter [Privacy Controls](Configuration#privacy-controls) setting is enabled in the Hosted service (requires `READ` permission on bucket or object to discover or access the file and related data). This removes the abiility to search for objects that you don't have permissions for.
+- The stricter [Privacy Controls](Configuration.md#privacy-controls) setting is enabled in the Hosted service (requires `READ` permission on bucket or object to discover or access the file and related data). This removes the abiility to search for objects that you don't have permissions for.
 
 ### Additional features
 
 - **BCBox Integration:** Using the Hosted COMS service has the added benefit of being able to integrate your application with [BCBox](https://bcbox.nrs.gov.bc.ca/) - a hosted drop-box type interface for sharing files.
 
-- A **Synchronization** feature is [coming soon](Product-Roadmap) that will allow COMS to manage objects that were in the bucket or are handled outside of the COMS API.
+- A **Synchronization** feature is [coming soon](Product-Roadmap.md) that will allow COMS to manage objects that were in the bucket or are handled outside of the COMS API.
 
 ### Environments
 
@@ -39,4 +39,4 @@ Some important aspects of the hosted service to consider:
 ***
 <br />
 
-**Note:** Please also review the [Hosting Considerations](Hosting-Considerations) page, and reasons to [self-host](Self-Hosting-COMS).
+**Note:** Please also review the [Hosting Considerations](Hosting-Considerations.md) page, and reasons to [self-host](Self-Hosting-COMS.md).

docs/Hosting-Considerations.md

@@ -7,10 +7,10 @@ Feature Comparison:
 |   Keycloak Realm |   SSO '[Standard Realm](https://github.com/bcgov/sso-keycloak/wiki#standard-service)' |   any OIDC realm
 | &nbsp; IDP support | &nbsp; `IDIR`<br />&nbsp; `Basic BCeID`<br />&nbsp; `Business BCeID` | &nbsp; Configurable
 | &nbsp; [BCBox](https://bcbox.nrs.gov.bc.ca/) integration | <ul><li>[x] </li></ul> | <ul><li>[ ] </li></ul>
-| &nbsp; Hosting Platform | &nbsp; [OpenShift](Architecture-Hosted#infrastructure) | &nbsp; [Source Code](https://github.com/bcgov/common-object-management-service/)<br />&nbsp; [Docker](https://hub.docker.com/r/bcgovimages/common-object-management-service/)<br />&nbsp; [OpenShift](Architecture-Hosted#infrastructure)
+| &nbsp; Hosting Platform | &nbsp; [OpenShift](Architecture-Hosted.md#infrastructure) | &nbsp; [Source Code](https://github.com/bcgov/common-object-management-service/)<br />&nbsp; [Docker](https://hub.docker.com/r/bcgovimages/common-object-management-service/)<br />&nbsp; [OpenShift](Architecture-Hosted.md#infrastructure)
 | &nbsp; Database Custodians | &nbsp; Us | &nbsp; You
 | &nbsp; Object Storage Custodians | &nbsp; You | &nbsp; You
 | &nbsp; Multi-bucket support | <ul><li>[x] </li></ul> | <ul><li>[x] </li></ul>
-| &nbsp; Strict [Privacy mode](Configuration#privacy-controls)  | <ul><li>[x] </li></ul> | &nbsp; Configurable
-| &nbsp; [No-Auth mode](Configuration#unauthenticated)| <ul><li>[ ] </li></ul> | &nbsp; Configurable
+| &nbsp; Strict [Privacy mode](Configuration.md#privacy-controls)  | <ul><li>[x] </li></ul> | &nbsp; Configurable
+| &nbsp; [No-Auth mode](Configuration.md#unauthenticated)| <ul><li>[ ] </li></ul> | &nbsp; Configurable
 | &nbsp; Custom configuration options | <ul><li>[ ] </li></ul> | <ul><li>[x] </li></ul>

docs/index.md

@@ -6,35 +6,35 @@ A microservice for managing access control to S3 Objects
 
 **API User Guide:**
 
-- [Authentication](Authentication)
-- [Endpoint Notes](Endpoint-Notes)
-- [Permissions](Permissions)
-- [Metadata and Tags](Metadata-Tag)
-- [Managing buckets](Buckets)
-- [Synchronization](Synchronization)
-- [Use-Case Examples](Use-Case-Examples)
+- [Authentication](Authentication.md)
+- [Endpoint Notes](Endpoint-Notes.md)
+- [Permissions](Permissions.md)
+- [Metadata and Tags](Metadata-Tag.md)
+- [Managing buckets](Buckets.md)
+- [Synchronization](Synchronization.md)
+- [Use-Case Examples](Use-Case-Examples.md)
 
 **Deployment Guide:**<br />
 Install COMS in your own environment for extra features
 
-- [Self-Hosting COMS](Self-Hosting-COMS)
-- [Architecture](Architecture)
-  - [Database](Architecture#database-structure)
-  - [Code Design](Architecture#code-design)
-- [Configuration Options](Configuration)
-- [Testing](Testing)
+- [Self-Hosting COMS](Self-Hosting-COMS.md)
+- [Architecture](Architecture.md)
+  - [Database](Architecture.md#database-structure)
+  - [Code Design](Architecture.md#code-design)
+- [Configuration Options](Configuration.md)
+- [Testing](Testing.md)
 
 **The Hosted Service:**<br />
 Find out if the BC Gov Hosted COMS service will work for you?
 
-- [Hosted Service Onboarding](Hosted-Service-Onboarding)
-- [Hosting Considerations](Hosting-Considerations)
-- [Hosted Service Architecture](Architecture-Hosted)
+- [Hosted Service Onboarding](Hosted-Service-Onboarding.md)
+- [Hosting Considerations](Hosting-Considerations.md)
+- [Hosted Service Architecture](Architecture-Hosted.md)
 
 
 <br />
 
-**[Product Roadmap](Product-Roadmap)**
+**[Product Roadmap](Product-Roadmap.md)**
 
 ***
 

docs/sample pages/about-us.md

@@ -0,0 +1,7 @@
+# About us
+
+## Suggested Content
+
+Introduce your team or project for a more in-depth understanding for your users
+
+

docs/sample pages/configuration.md

@@ -0,0 +1,7 @@
+# Configuration
+
+## Suggested Content
+
+* Explain configuration/customization requirements, if necessary
+* Guide on tailoring the service to specific needs
+* Provide instructions for integrating with other systems if needed

docs/sample pages/getting-started.md

@@ -0,0 +1,7 @@
+# Getting started
+
+## Suggested Content
+* Provide step-by-step instructions for system setup
+* List prerequisites and system requirements
+* Determine if visual aids are necessary for better comprehension, keeping in mind to [create accessible content](https://digital.gov.bc.ca/wcag/home/intro/) and review the [accessibility and inclusion toolkit](https://www2.gov.bc.ca/gov/content/home/accessible-government/toolkit)
+* Address common issues and provide troubleshooting solutions

docs/sample pages/tips-and-tricks.md

@@ -0,0 +1,7 @@
+# Tips and tricks
+
+## Suggested Content
+
+* Contribute to the overall success of a development project
+* Promote efficiency, code quality, collaboration, security, and adaptability
+* Ensure the knowledge base required aligns with your entire audience; assess if it suits their needs