Skip to content

Commit

Permalink
Update readme, templates, and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wilwade committed Aug 6, 2024
1 parent e5a2323 commit eeea8c0
Show file tree
Hide file tree
Showing 15 changed files with 44 additions and 848 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright Amplica Labs
Copyright Project Liberty LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,56 +68,56 @@ Each Gateway services is an independent microservice.
<details>
<summary>Account Service</summary>

- [API Documentation](https://amplicalabs.github.io/gateway/account)
- [API Documentation](https://projectlibertylabs.github.io/gateway/account)
- [README](./services/account/README.md)

</details>

<details>
<summary>Graph Service</summary>

- [API Documentation](https://amplicalabs.github.io/gateway/graph/)
- [API Documentation](https://projectlibertylabs.github.io/gateway/graph/)
- [README](./services/graph/README.md)

</details>

<details>
<summary>Content Publishing Service</summary>

- [API Documentation](https://amplicalabs.github.io/gateway/content-publishing/)
- [API Documentation](https://projectlibertylabs.github.io/gateway/content-publishing/)
- [README](./services/content-publishing/README.md)

</details>

<details>
<summary>Content Watcher Service</summary>

- [API Documentation](https://amplicalabs.github.io/gateway/content-watcher/)
- [API Documentation](https://projectlibertylabs.github.io/gateway/content-watcher/)
- [README](./services/content-watcher/README.md)

</details>

<details>
<summary>Reconnection Service</summary>

- [API Documentation](https://amplicalabs.github.io/reconnection-service/)
- [GitHub](https://github.com/AmplicaLabs/reconnection-service)
- [API Documentation](https://projectlibertylabs.github.io/reconnection-service/)
- [GitHub](https://github.com/ProjectLibertyLabs/reconnection-service)

</details>

<!-- LIVE Docs -->

## 🚀 Live Docs

- [Live Docs](https://amplicalabs.github.io/gateway/)
- [Live Docs](https://projectlibertylabs.github.io/gateway/)

<p align="right">(<a href="#-table-of-contents">back to top</a>)</p>

<!-- GETTING STARTED -->

## 💻 Getting Started

For a more detailed tutorial, visit [Live Docs](https://amplicalabs.github.io/gateway/).
For a more detailed tutorial, visit [Live Docs](https://projectlibertylabs.github.io/gateway/).

To get a local copy up and running, follow these steps.

Expand All @@ -135,7 +135,7 @@ Clone this repository to your desired folder:
Clone:

```sh
git clone [email protected]:AmplicaLabs/gateway.git
git clone [email protected]:ProjectLibertyLabs/gateway.git
cd gateway
```

Expand Down Expand Up @@ -169,7 +169,7 @@ To build and serve the Gateway Documentation:

### Deployment

Deployment of the Gateway services have various options. See the [Live Docs](https://amplicalabs.github.io/gateway/) for more details.
Deployment of the Gateway services have various options. See the [Live Docs](https://projectlibertylabs.github.io/gateway/) for more details.

Deployment of the Gateway documentation occurs via merge to `main` branch via GitHub Actions.

Expand All @@ -182,7 +182,7 @@ Deployment of the Gateway documentation occurs via merge to `main` branch via Gi
Contributions, issues, and feature requests are welcome!

- [Contributing Guidelines](./CONTRIBUTING.md)
- [Open Issues](https://github.com/AmplicaLabs/gateway/issues)
- [Open Issues](https://github.com/ProjectLibertyLabs/gateway/issues)

<p align="right">(<a href="#-table-of-contents">back to top</a>)</p>

Expand Down
2 changes: 1 addition & 1 deletion docs/book.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[book]
authors = ["Amplica Labs"]
authors = ["Project Liberty Labs"]
language = "en"
multilingual = false
src = "src"
Expand Down
2 changes: 1 addition & 1 deletion services/account/.prettierrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"@amplica-labs/prettier-config"
"@projectlibertylabs/prettier-config"
201 changes: 0 additions & 201 deletions services/account/LICENSE

This file was deleted.

8 changes: 4 additions & 4 deletions services/account/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ The API is responsible for handling incoming HTTP requests and the Worker is res

### Key Features

- **Account creation using [SIWF](https://github.com/AmplicaLabs/siwf)**
- **Account creation using [SIWF](https://github.com/ProjectLibertyLabs/siwf)**
- Includes behind the scenes delegation to the provider
- **Get User and Provider Account(s)**
- **Handle (aka username) claiming**
Expand All @@ -163,7 +163,7 @@ The API is responsible for handling incoming HTTP requests and the Worker is res

## 🚀 Live Docs

- [Live Docs](https://amplicalabs.github.io/account-service)
- [Live Docs](https://projectlibertylabs.github.io/account-service)

<p align="right">(<a href="#-table-of-contents">back to top</a>)</p>

Expand All @@ -187,7 +187,7 @@ Clone this repository to your desired folder:
Example commands:

```sh
git clone [email protected]:AmplicaLabs/account-service.git
git clone [email protected]:ProjectLibertyLabs/account-service.git
cd account-service
```

Expand Down Expand Up @@ -333,7 +333,7 @@ You may also view and manage the application's queue at [http://localhost:3000/q
Contributions, issues, and feature requests are welcome!
- [Contributing Guidelines](./CONTRIBUTING.md)
- [Open Issues](https://github.com/AmplicaLabs/acccount-service/issues)
- [Open Issues](https://github.com/ProjectLibertyLabs/acccount-service/issues)
<p align="right">(<a href="#-table-of-contents">back to top</a>)</p>
Expand Down
2 changes: 1 addition & 1 deletion services/account/env.template
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ HEALTH_CHECK_SUCCESS_THRESHOLD=10
CAPACITY_LIMIT='{"type":"percentage", "value":80}'

# URL for the Sign-In With Frequency UI
SIWF_URL=https://amplicalabs.github.io/siwf/ui
SIWF_URL=https://projectlibertylabs.github.io/siwf/ui

# Domain for the Sign-in with Frequency login payload
SIWF_DOMAIN=localhost
Expand Down
8 changes: 4 additions & 4 deletions services/content-publishing/INSTALLING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ The application requires a Redis server that is configured with `Append-only fil

### Standalone (complete) image

The standalone container image is meant to be a complete solution for a provider. It contains a single instance of the main application, plus a pre-configured Redis server. Simply download the latest [container image](https://hub.docker.com/r/amplicalabs/content-publishing-service/) and deploy using your favorite container management system.
The standalone container image is meant to be a complete solution for a provider. It contains a single instance of the main application, plus a pre-configured Redis server. Simply download the latest [container image](https://hub.docker.com/r/projectlibertylabs/content-publishing-service/) and deploy using your favorite container management system.
```
docker pull amplicalabs/content-publishing-service:standalone-latest
docker pull projectlibertylabs/content-publishing-service:standalone-latest
```

The internal Redis server included in the complete image is already configured for persistence; it is simply necessary to configure your container pod to map the directory `/var/lib/redis` to a persistent storage volume.
Expand All @@ -22,9 +22,9 @@ Follow the instructions below for [configuration](#configuration), with the exce

### App-only image

The app-only image is meant to be used for providers who would rather utilize a Redis instance in their own (or their cloud infrastructure provider's) external Redis instance or service. To download the latest [container image](https://hub.docker.com/r/amplicalabs/content-publishing-service/), simply:
The app-only image is meant to be used for providers who would rather utilize a Redis instance in their own (or their cloud infrastructure provider's) external Redis instance or service. To download the latest [container image](https://hub.docker.com/r/projectlibertylabs/content-publishing-service/), simply:
```
docker pull amplicalabs/content-publishing-service:apponly-latest
docker pull projectlibertylabs/content-publishing-service:apponly-latest
```
In this case, you need to ensure that the following settings are configured in your Redis instance:
```
Expand Down
Loading

0 comments on commit eeea8c0

Please sign in to comment.