From 30c2ce6d560e5315acf0a93659d1b03c580df8ce Mon Sep 17 00:00:00 2001 From: Dmitry S Date: Wed, 11 Dec 2024 15:03:34 -0500 Subject: [PATCH 1/2] Fix links to function reference, and some internal links in new English-language articles. Function reference is linked twice in the TOC, with the duplicate link pointing to the single article. This change restores the previous approach. It doesn't work with localization, but no title are localized yet, so this can be addressed later. Other links are fixed to address warnings from mkdocs. --- help/en/docs/install/aws-marketplace-legacy.md | 4 ++-- help/en/docs/install/aws-marketplace-transition.md | 6 +++--- help/en/docs/install/aws-marketplace.md | 2 +- help/en/docs/self-managed.md | 2 +- mkdocs.yml | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/help/en/docs/install/aws-marketplace-legacy.md b/help/en/docs/install/aws-marketplace-legacy.md index a64d3fa86..52946abfc 100644 --- a/help/en/docs/install/aws-marketplace-legacy.md +++ b/help/en/docs/install/aws-marketplace-legacy.md @@ -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 @@ -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`. diff --git a/help/en/docs/install/aws-marketplace-transition.md b/help/en/docs/install/aws-marketplace-transition.md index 36e98f364..70f25ba55 100644 --- a/help/en/docs/install/aws-marketplace-transition.md +++ b/help/en/docs/install/aws-marketplace-transition.md @@ -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 @@ -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 diff --git a/help/en/docs/install/aws-marketplace.md b/help/en/docs/install/aws-marketplace.md index 00bf7fdce..58592523f 100644 --- a/help/en/docs/install/aws-marketplace.md +++ b/help/en/docs/install/aws-marketplace.md @@ -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). diff --git a/help/en/docs/self-managed.md b/help/en/docs/self-managed.md index 3ea16fe11..0eb15d1be 100644 --- a/help/en/docs/self-managed.md +++ b/help/en/docs/self-managed.md @@ -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. diff --git a/mkdocs.yml b/mkdocs.yml index ebb33cba5..cfff78673 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -177,7 +177,7 @@ 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 + - Function reference: /functions/ - limits.md - data-security.md - browser-support.md From 2accf884238d4694099a0f830d56bf5138eb9036 Mon Sep 17 00:00:00 2001 From: Dmitry S Date: Wed, 11 Dec 2024 15:38:41 -0500 Subject: [PATCH 2/2] Add a TODO about localizing the external link in nav --- mkdocs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/mkdocs.yml b/mkdocs.yml index cfff78673..cadbf237e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -177,6 +177,7 @@ 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. + # TODO: this needs a special way to localize the nav entry, perhaps similar to section titles. - Function reference: /functions/ - limits.md - data-security.md