Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix links to function reference, and some internal links in new English-language articles #454

Merged
merged 2 commits into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions help/en/docs/install/aws-marketplace-legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ AWS Marketplace (Legacy) {: .tag-core .tag-ee }
=============

!!! warning "Note"
This documentation refers to the legacy version of Grist on the AWS Marketplace, based on [Grist Omnibus](https://github.com/gristlabs/grist-omnibus). You can find the documentation for the current offering [here](../aws-marketplace). Also consult, our [transitioning notes](../aws-marketplace-transition).
This documentation refers to the legacy version of Grist on the AWS Marketplace, based on [Grist Omnibus](https://github.com/gristlabs/grist-omnibus). You can find the documentation for the current offering [here](aws-marketplace.md). Also consult, our [transitioning notes](aws-marketplace-transition.md).

## First run setup

Expand All @@ -29,7 +29,7 @@ Once the above steps are completed, you should be able to access Grist on your c

## Authentication setup

Once you have [your Microsoft or Google client ID and secret](../aws-marketplace#authentication-setup), you’ll need to pass them to the `gristParameters` file inside the Grist EC2 instance:
Once you have [your Microsoft or Google client ID and secret](aws-marketplace.md#authentication-setup), you’ll need to pass them to the `gristParameters` file inside the Grist EC2 instance:

1. Log in to the Grist EC2 instance.
2. Open `~/grist/gristParameters`.
Expand Down
6 changes: 3 additions & 3 deletions help/en/docs/install/aws-marketplace-transition.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Omnibus.
It is possible to copy your Grist documents to Builder Edition.

1. Take note of the `EMAIL` variable under `~/grist/gristParameters`.
2. Start [a Grist Builder Edition instance](../aws-marketplace).
2. Start [a Grist Builder Edition instance](aws-marketplace.md).
3. Follow [the instructions to run the bootstrap
script](https://github.com/gristlabs/grist-pack/tree/main/dist#quickstart),
using the value of `EMAIL` for the `DEFAULT_EMAIL` value. See
[here](../../self-managed#what-is-the-administrative-account) for
[here](../self-managed.md#what-is-the-administrative-account) for
more details pertaining to this variable.

You do not need to run `docker compose up`, but it can be helpful
Expand All @@ -28,7 +28,7 @@ this directory:
* The entire `~/grist-persist/docs` directory

Also see ["What files does Grist
store?"](../../self-managed#what-files-does-grist-store) for an
store?"](../self-managed.md#what-files-does-grist-store) for an
explanation of what these files are.

There are a couple of standard methods to copy files across EC2
Expand Down
2 changes: 1 addition & 1 deletion help/en/docs/install/aws-marketplace.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ To configure Grist authentication with Google or Microsoft, you must have an app

* The Grist EC2 instance should have the “Persistent store” option checked.
* By default, Grist Builder Edition stores cryptographic authentication configuration and all data under `/home/grist/persist`. Deleting this folder will result in a loss of all data from all documents.
* If you are using the legacy version based on [Grist Omnibus](https://github.com/gristlabs/grist-omnibus), please refer to the [legacy documentation](../aws-marketplace-legacy).
* If you are using the legacy version based on [Grist Omnibus](https://github.com/gristlabs/grist-omnibus), please refer to the [legacy documentation](aws-marketplace-legacy.md).
2 changes: 1 addition & 1 deletion help/en/docs/self-managed.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ administrator](self-managed.md#what-is-the-administrative-account) may
temporarily lose access to the team site.

In order to prevent this, before changing `GRIST_DEFAULT_EMAIL` use
[team sharing options](../team-sharing) to add new owners to the team
[team sharing options](team-sharing.md) to add new owners to the team
site, since apart from initial creation, administrators have no
automatic right to team site membership.

Expand Down
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@ nav:
- keyboard-shortcuts.md
# The function reference (functions.md) is listed above; here is an intentionally non-standard
# link, so that only the above page item gets highlighted when the function reference is open.
- functions.md
# TODO: this needs a special way to localize the nav entry, perhaps similar to section titles.
- Function reference: /functions/
- limits.md
- data-security.md
- browser-support.md
Expand Down
Loading