Skip to content

Commit

Permalink
tweak content and fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
fnalways committed Nov 6, 2024
1 parent 7908905 commit d30fb88
Show file tree
Hide file tree
Showing 38 changed files with 92 additions and 91 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Terminus Docs
# Olares Docs

## Run

Expand Down
2 changes: 1 addition & 1 deletion docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export default withMermaid({
options: {
appId: "0614S1555J",
apiKey: "cbf4702e9d6bfb5a0ae85bf0d486a591",
indexName: "olares",
indexName: "jointerminus",
locales: {
zh: {
placeholder: "搜索文档",
Expand Down
4 changes: 2 additions & 2 deletions docs/.vitepress/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,7 @@ const side = {
text: "Back up and restore",
link: "/manual/space/backup-restore",
},
{ text: "Billing", link: "/manual/billing" },
{ text: "Billing", link: "/manual/space/billing" },
],
},
{
Expand Down Expand Up @@ -497,7 +497,7 @@ const side = {
export const en = defineConfig({
lang: "/",
themeConfig: {
logo: "/icon.png",
//logo: "/icon.png",
socialLinks: [{ icon: "github", link: "https://github.com/beclab" }],

nav: [
Expand Down
4 changes: 2 additions & 2 deletions docs/developer/contribute/system-app/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The system application need to be installed under the `user-space` namespace. Th
applications.app.bytetrade.io/owner: {{ .Values.bfl.username }}
applications.app.bytetrade.io/author: bytetrade.io
annotations:
applications.app.bytetrade.io/icon: https://docs-dev.olares.com/icon. png
applications.app.bytetrade.io/icon: https://docs-dev.olares.xyz/icon. png
applications.app.bytetrade.io/title: Desktop-dev
applications.app.bytetrade.io/version: '0.0.1'
Expand Down Expand Up @@ -123,7 +123,7 @@ metadata:
applications.app.bytetrade.io/owner: {{ .Values.bfl.username }}
applications.app.bytetrade.io/author: bytetrade.io
annotations:
applications.app.bytetrade.io/icon: https://docs-dev.olares.com/icon.png
applications.app.bytetrade.io/icon: https://docs-dev.olares.xyz/icon.png
applications.app.bytetrade.io/title: Desktop-dev
applications.app.bytetrade.io/version: '0.0.1'
applications.app.bytetrade.io/entrances: '[{"name":"desktop-frontend-dev", "host":"desktop-svc-dev", "port":80,"title":"Desktop-dev"}]'
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/develop/advanced/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ cd install-wizard && bash change_ip.sh
This command is not applicable to Olares on macOS yet.
:::

## Add a Olares node locally
## Add an Olares node locally

**Before Install**
- Get the `internal IP address` of the **Master** node.
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/develop/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Developing applications on **Olares** is not much different from regular website
- [Extensions field to Helm in Olares](./package/extension.md)

- [Exploring Our Tutorials](./tutorial/)
- [Learn about Devbox, a Olares Development Tool](./tutorial/devbox.md)
- [Learn about Devbox, an Olares Development Tool](./tutorial/devbox.md)
- [Creating your first application](./tutorial/note/)
- [Exploring Advanced Concepts](./advanced/)
- [Submitting Applications to the Olares Market](./submit/)
2 changes: 1 addition & 1 deletion docs/developer/develop/package/manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: [2, 3]

# OlaresManifest Specification

Every **Olares Application Chart** should include a `OlaresManifest.yaml` file in the root directory. `OlaresManifest.yaml` provides all the essential information about a Olares App. Both the **Olares Market protocol** and the **Olares** depend on this information to distribute and install applications.
Every **Olares Application Chart** should include a `OlaresManifest.yaml` file in the root directory. `OlaresManifest.yaml` provides all the essential information about an Olares App. Both the **Olares Market protocol** and the **Olares** depend on this information to distribute and install applications.

Here's an example of what a `OlaresManifest.yaml` file might look like:

Expand Down
2 changes: 1 addition & 1 deletion docs/developer/develop/tutorial/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tutorial

Welcome to the Olares developer guides. These detailed tutorials offer a step-by-step guide on building a Olares Application from scratch.
Welcome to the Olares developer guides. These detailed tutorials offer a step-by-step guide on building an Olares Application from scratch.

To get started, you can learn some basic concepts of Olares, such as:
- [Olares architectural components](../../../manual/concepts/architecture)
Expand Down
2 changes: 1 addition & 1 deletion docs/developer/develop/tutorial/note/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The tutorial shows how to make a simple [Note](https://github.com/beclab/olares-
The tutorial includes three parts:

1. [Create an App](./create.md)<br>
This section provides a step-by-step guide on how to create a Olares App and set up the initial development environment.
This section provides a step-by-step guide on how to create an Olares App and set up the initial development environment.

2. [Backend Development](./backend.md)<br>
In this section, you'll learn how to use DevBox's IDE to develop the backend programs in `Golang` and provide API interfaces for the frontend.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ hero:
actions:
- theme: brand
text: What is Olares?
link: /overview/introduction/what-is-olares
link: /manual/feature-overview.html
- theme: alt
text: Get Started
link: /overview/introduction/
link: /manual/get-started/
- theme: alt
text: GitHub
link: https://github.com/beclab/olares
Expand Down
4 changes: 4 additions & 0 deletions docs/manual/docs-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Olares (formerly Terminus) is a free, source-available, cloud-native operating s

For a comprehensive overview of the system, visit our [GitHub repository](https://github.com/beclab/olares).

:::info Note
Screenshots are being updated to reflect our new branding. Screenshots may differ slightly from UI elements referred.
:::

## New to Olares?

The getting-started guide covers creating an Olares ID and setting up Olares on your local machine.
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/feature-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Olares offers a wide array of features designed to enhance security, ease of use, and development flexibility:

- **Enterprise-grade security**: Simplified network configuration using Tailscale, Headscale, Cloudflare Tunnel, and FRP.
- **Secure and permissionless application ecosystem**: Sandboxing ensures application isolation and security.
- **Secure and permissionless application ecosystem**: Sandboxing ensures application isolation and security. [See what Olares Market has to offer](https://market.olares.xyz/).
- **Unified file system and database**: Automated scaling, backups, and high availability.
- **Single sign-on**: Log in once to access all applications within Olares with a shared authentication service.
- **AI capabilities**: Comprehensive solution for GPU management, local AI model hosting, and private knowledge bases while maintaining data privacy.
Expand Down
4 changes: 2 additions & 2 deletions docs/manual/get-started/back-up-mnemonics.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ After setting up, you can choose to enable biometric unlock for more secure and
6. Securely record the mnemonic phrase and store it in a safe place.
7. Click **Next**.
:::warning
While clicking Copy will save the mnemonic phrase to your clipboard, this poses a security risk. For maximum security, we strongly recommend backing up your mnemonic phrase offline. :::
While clicking **Copy** will save the mnemonic phrase to your clipboard, this poses a security risk. For maximum security, we strongly recommend backing up your mnemonic phrase offline.
:::
8. Verify your backup by arranging the mnemonic phrase in the correct order.
9. Click **Completed**.
Expand All @@ -48,4 +48,4 @@ If you encounter a password error, it may be because you haven't set a local pas

## Congratulations!
And now you're ready to discover Olares further:
- [Next steps](./next-steps.md)
- [What's next](./next-steps.md)
6 changes: 3 additions & 3 deletions docs/manual/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ If you prefer to try the cloud version of Olares instead of self-hosting, refer
:::

<div class="cta">
<a href="./get-started/">
<a href="../create-olares-id">
<div class="content">
<h3>First time using Olares?</h3>
<p>Learn how to create an Olares ID, and get your Olares up and running.</p>
Expand All @@ -15,7 +15,7 @@ If you prefer to try the cloud version of Olares instead of self-hosting, refer
</div>

<div class="cta">
<a href="./get-started/">
<a href="../../tasks/">
<div class="content">
<h3>Already have an Olares?</h3>
<p>Explore our comprehensive how-to guide covering every aspect of Olares.</p>
Expand All @@ -25,7 +25,7 @@ If you prefer to try the cloud version of Olares instead of self-hosting, refer
</div>

<div class="cta">
<a href="./get-started/">
<a href="../../../tasks/team">
<div class="content">
<h3>Team up in Olares?</h3>
<p>Discover how to leverage Olares for collaborative work and team management.</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/get-started/install-olares.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,5 +287,5 @@ Upon completion of the installation, the initial system information, including t
![alt text](/images/how-to/olares/one_time_password.png)

## Next step

Now that you have installed Olares, the next step is to activate your system for use, similar to setting up a new smartphone:
- [Activate Olares](./activate-olares)
12 changes: 6 additions & 6 deletions docs/manual/get-started/next-steps.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# What's next

Congratulations! You're now ready to dive into Olares's powerful features. You will find it easy to get things done in Olares.
You're now ready to dive into Olares's powerful features. You will find it easy to get things done in Olares.

Here are some suggested next steps:

Expand Down Expand Up @@ -44,13 +44,13 @@ Here are some suggested next steps:
description="Deepen your understanding of Olares."
:links="[
{ text: 'Olares core components',
href: 'placeholder' },
href: '../concepts/architecture' },
{ text: 'Olares ID',
href: 'placeholder' },
href: '../concepts/olares-id' },
{ text: 'Account',
href: '../concepts/account' },
{ text: 'Application',
href: 'placeholder' },
{ text: 'Recommend',
href: 'placeholder' }]"
href: '../concepts/application' },]"
buttonText="Learn more"
buttonLink="../concepts/"
/>
Expand Down
6 changes: 3 additions & 3 deletions docs/manual/help/faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Olares consists of a series of projects using a hierarchical authorization appro

- Projects running on blockchain use Apache 2.0, such as [Snowinning Protocol](https://github.com/beclab/olaresdid-contract-system).
- Projects related to protocols use Apache 2.0, such as [r4](https://github.com/beclab/r4).
- Projects around [Olares](https://github.com/beclab/olares) and [LarePass](https://github.com/beclab/LarePass) use the [Olares License](https://github.com/beclab/Olares/blob/main/LICENSE.md).
- Projects around Olares and LarePass use the [Olares License](https://github.com/beclab/Olares/blob/main/LICENSE.md).
- For third-party applications running on Olares, it is up to the developer to decide whether they want them open source or not and choose the license accordingly.

For more details, visit our projects on [GitHub](https://github.com/beclab).
Expand Down Expand Up @@ -43,7 +43,7 @@ Meanwhile, Olares aims to provide a one-stop self-hosted solution, which goes be

## I have several servers. Can I use Olares to manage them one-stop?

Yes. You can refer to [How to add a node](../../developer/develop/advanced/cli#add-a-olares-node-locally).
Yes. You can refer to [How to add a node](../../developer/develop/advanced/cli#add-an-olares-node-locally).

After you add the node, you can manage the cluster via [Dashboard](../tasks/resources-usage) and [Control Hub](../tasks/navigate-control-hub).

Expand Down Expand Up @@ -100,7 +100,7 @@ However, there are chances that applications developed through this method canno

We use the term Olares under two scenarios:

- Describing the entire project and the OS. Specifically, it refers to the complete architecture including 3 core components and extension protocols.
- Describing the entire project and the operating system. Specifically, it refers to the complete architecture including 3 core components and extension protocols.
- Describing the hardware devices running Olares. Be it a Raspberry Pi or a cluster of multiple machines on the cloud, all can be called Olares.


Expand Down
4 changes: 2 additions & 2 deletions docs/manual/space/host-domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,11 @@ Now that your organization has a verified domain name, you or other members you

![org-olares-id](/images/how-to/larepass/organization_olares_id.png)

1. In LarePass app, navigate to **Organization Olares ID** > **Join an existing organization**.
1. In the LarePass app, navigate to **Organization Olares ID** > **Join an existing organization**.
2. Enter your organization's domain name and click **Continue**. Recheck whether your domain name has been verified and configured if an error occurs.
3. Bind the VC via your email accounts. Currently, only Gmail and Google Workspace email are supported.

Upon completion, you will receive an Organization Olares ID. Now you can go ahead to [Activate Olares](../get-started/activate-olares)
Upon completion, you will receive an Organization Olares ID. Now you can go ahead to [Activate Olares](../get-started/activate-olares).

## Domain status and processing

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/space/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This section walks you through usages of Olares Space, covering:
- [Manage Olares](manage-olares.md)
- [Host custom domains](host-domain.md)
- [Manage organization domains](manage-domain.md)
- [Backup & Restore Olares](backup-restore.md)
- [Back up & Restore Olares](backup-restore.md)
- [Usage and Billing](billing.md)


2 changes: 1 addition & 1 deletion docs/manual/space/manage-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide walks you through common account operations with Olares Space, includ

Olares Space uses a decentralized ID (DID) or Olares ID for authentication. Make sure you already have obtained your credentials on your LarePass.

1. In LarePass app, select the DID or Olares ID you wish to use to log in.
1. In the LarePass app, select the DID or Olares ID you wish to use to log in.
2. Open https://space.olares.xyz/ in your browser.
3. Scan the QR code using LarePass.

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/space/manage-olares.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,4 @@ Currently, we do not offer cloud instances that include GPUs. However, for users
For Large Language Models (LLMs), the shared GPU solution is still under development and may require further enhancements.
:::

If you need GPU support, please [contact us](mailto:support@olares.com) for more information.
If you need GPU support, please reach us on [Discord](https://discord.com/invite/BzfqrgQPDK).
2 changes: 1 addition & 1 deletion docs/manual/tasks/access-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ You can access Olares applications anytime, anywhere, whether you're accessing f
- Personalize domain name for your applications
- Allow public access without authentication

## Before you start
## Before you begin
Before you start, it is recommended to familiarize yourself with a few concepts for Olares applications:

- [Endpoints](../concepts/network.md#endpoints)
Expand Down
4 changes: 2 additions & 2 deletions docs/manual/tasks/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ It consists of three main components:

---
<div>
<h4><a href="./add-edit-download/">Add, edit, and download files</a></h4>
<h4><a href="./add-edit-download">Add, edit, and download files</a></h4>
Learn the fundamentals of file management in Olares.
</div>

<div>
<h4><a href="./sync-share/">Sync and share files</a></h4>
<h4><a href="./sync-share">Sync and share files</a></h4>
Learn how to keep files updated across devices, and how to share files with other Olares member.
</div>

Expand Down
Loading

0 comments on commit d30fb88

Please sign in to comment.