Skip to content

Commit e165b3d

Browse files
authored
Revert "V6 user guides (#744)" (#749)
This reverts commit 9a160d9.
1 parent 9a160d9 commit e165b3d

245 files changed

Lines changed: 4597 additions & 5094 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs.config.ts

Lines changed: 3 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -34,63 +34,16 @@ const linkWhitelist: string[] = [...redirects.map(r => r.source), "/forms/produc
3434
*/
3535
const whitelistedVersions: string[] = [];
3636

37-
/**
38-
* Only build versions at or above this version (e.g., "5.40.x").
39-
* Set via MIN_VERSION environment variable or modify here.
40-
* Set to empty string to build all versions.
41-
*/
42-
const minVersionToBuild = process.env.MIN_VERSION || "";
43-
4437
const filterByEnvironment = (version: Version) => {
4538
// In `preview`, if there are specific versions whitelisted for deployment, those are the only ones we'll output.
4639
if (preview && whitelistedVersions.length > 0) {
4740
return whitelistedVersions.includes(version.getValue());
4841
}
4942

50-
// If minVersionToBuild is set, only build versions >= minVersion or `latest`.
51-
if (minVersionToBuild) {
52-
if (minVersionToBuild === "latest") {
53-
return version.isLatest();
54-
}
55-
const versionNum = parseFloat(version.getValue().replace(/[^\d.]/g, ""));
56-
const minVersionNum = parseFloat(minVersionToBuild.replace(/[^\d.]/g, ""));
57-
return versionNum >= minVersionNum;
58-
}
59-
6043
// Build everything.
6144
return true;
6245
};
6346

64-
const filterFilePathByVersion = (filePath: string): boolean => {
65-
// Extract version from file path (e.g., /docs/developer-docs/5.40.x/... or /docs/user-guides/5.40.x/...)
66-
const versionMatch = filePath.match(/\/(\d+\.\d+\.x)\//);
67-
68-
if (!versionMatch) {
69-
// If no version in path, include the file (e.g., non-versioned docs)
70-
return true;
71-
}
72-
73-
const versionString = versionMatch[1];
74-
75-
// Use the same filtering logic as filterByEnvironment
76-
if (preview && whitelistedVersions.length > 0) {
77-
return whitelistedVersions.includes(versionString);
78-
}
79-
80-
if (minVersionToBuild) {
81-
if (minVersionToBuild === "latest") {
82-
// For file paths, we can't determine if it's "latest" without more context
83-
// So we'll include all versioned files when minVersionToBuild is "latest"
84-
return true;
85-
}
86-
const versionNum = parseFloat(versionString.replace(/[^\d.]/g, ""));
87-
const minVersionNum = parseFloat(minVersionToBuild.replace(/[^\d.]/g, ""));
88-
return versionNum >= minVersionNum;
89-
}
90-
91-
return true;
92-
};
93-
9447
const existsInDocs = (link: string) => {
9548
return fs.pathExists(path.join(__dirname, `src/pages/${link}.js`));
9649
};
@@ -99,13 +52,9 @@ export default {
9952
projectRootDir: __dirname,
10053
cleanOutputDir: path.resolve("src/pages/docs"),
10154
sitemapOutputPath: path.resolve("public/algolia/sitemap.xml"),
102-
linkValidator: new LinkValidator(
103-
linkWhitelist,
104-
link => {
105-
return existsInDocs(link);
106-
},
107-
filterFilePathByVersion
108-
),
55+
linkValidator: new LinkValidator(linkWhitelist, link => {
56+
return existsInDocs(link);
57+
}),
10958
documentRoots: [
11059
/* Developer Docs */
11160
new VersionedDocumentRootConfig({

docs/developer-docs/5.28.x/core-development-concepts/scaffolding/react-application.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ import { createWatchApp, createBuildApp } from "@webiny/project-utils";
227227

228228
// Exports fundamental watch and build commands.
229229
// Need to inject environment variables or link your application with an existing GraphQL API?
230-
// See https://www.webiny.com/docs/{version}/core-development-concepts/scaffolding/full-stack-application/webiny-config.
230+
// See https://www.webiny.com/docs/core-development-concepts/scaffolding/full-stack-application/webiny-config.
231231
export default {
232232
commands: {
233233
async watch(options, context) {

docs/developer-docs/5.28.x/custom-app-tutorial/adding-user-pools/adding-user-pool-and-user-pool-domain.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ import Cloudfront from "./cloudfront";
124124
const DEBUG = String(process.env.DEBUG);
125125

126126
// Enables logs forwarding.
127-
// https://www.webiny.com/docs/{version}/core-development-concepts/basics/watch-command#enabling-logs-forwarding
127+
// https://www.webiny.com/docs/core-development-concepts/basics/watch-command#enabling-logs-forwarding
128128
const WEBINY_LOGS_FORWARD_URL = String(process.env.WEBINY_LOGS_FORWARD_URL);
129129

130130
export default () => {

docs/developer-docs/5.28.x/custom-app-tutorial/securing-graphql-api/initial-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ import Cognito from "./cognito";
7373
import S3 from "./s3";
7474

7575
// Among other things, this determines the amount of information we reveal on runtime errors.
76-
// https://www.webiny.com/docs/{version}/core-development-concepts/environment-variables/#debug-environment-variable
76+
// https://www.webiny.com/docs/core-development-concepts/environment-variables/#debug-environment-variable
7777
const DEBUG = String(process.env.DEBUG);
7878

7979
// Enables logs forwarding.

docs/developer-docs/5.28.x/get-started/install-webiny.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Before proceeding, make sure you have the following:
2727
- Webiny works with both yarn versions [1 (classic)](https://yarnpkg.com/en/docs/install) and [>=2 (berry)](https://yarnpkg.com/)
2828
- for version 1 - **1.22.0** or later is required
2929
3. **AWS account and user credentials**
30-
- in order to deploy Webiny, you must have a valid [AWS account and user credentials](/docs/{version}/infrastructure/aws/configure-aws-credentials) set up on your system
30+
- in order to deploy Webiny, you must have a valid [AWS account and user credentials](/docs/infrastructure/aws/configure-aws-credentials) set up on your system
3131

3232
## Project Setup
3333

docs/developer-docs/5.28.x/infrastructure/basics/environments.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,6 @@ In certain cases, this might be reasonable. For example, you can reduce developm
6767

6868
<Alert type="info">
6969

70-
Depending on the environment, the **API** project application is deployed as two different sets of cloud infrastructure resources - development and production. Visit the [API Overview - Default VPC](/docs/{version}/architecture/deployment-modes/development) key topic to learn more.
70+
Depending on the environment, the **API** project application is deployed as two different sets of cloud infrastructure resources - development and production. Visit the [API Overview - Default VPC](/docs/architecture/deployment-modes/development) key topic to learn more.
7171

7272
</Alert>

docs/developer-docs/5.28.x/infrastructure/pulumi-iac/iac-with-pulumi.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Currently, Webiny is not using the [Automation API](https://www.pulumi.com/blog/
174174
Switching to a different infrastructure-as-code (IaC) solution would require a significant amount of work as it would involve rewriting almost all of the Webiny IaC code from scratch for a different IaC solution. **Therefore, we do not recommend it.**
175175

176176
However, if you want to experiment with it, you would need to create a custom CLI plugin similar to the [Webiny CLI plugin for Pulumi](https://github.com/webiny/webiny-js/tree/next/packages/cli-plugin-deploy-pulumi). This plugin is responsible for creating the deploy, destroy, watch, and other commands.
177-
To use your custom plugin, you would then need to import it into the `webiny.project.ts` file and remove the Pulumi plugin. The most challenging part would be transforming all of the Pulumi code into respective IaC code (i.e. transforming all Pulumi code to [CloudFormation](https://aws.amazon.com/cloudformation/), [Terraform](https://www.terraform.io/), or other IaC). You can refer to the Pulumi code to see the resources Webiny deploys and the [Cloud Infrastructure documentation](https://www.webiny.com/docs/{version}/architecture/introduction) for more information.
177+
To use your custom plugin, you would then need to import it into the `webiny.project.ts` file and remove the Pulumi plugin. The most challenging part would be transforming all of the Pulumi code into respective IaC code (i.e. transforming all Pulumi code to [CloudFormation](https://aws.amazon.com/cloudformation/), [Terraform](https://www.terraform.io/), or other IaC). You can refer to the Pulumi code to see the resources Webiny deploys and the [Cloud Infrastructure documentation](https://www.webiny.com/docs/architecture/introduction) for more information.
178178

179179
**Please keep in mind that this process will require a significant amount of effort, and it's recommended to stick with Pulumi unless your organization has strict policies that require using a different IaC solution.**
180180

docs/developer-docs/5.29.x/admin-area/new-app-tutorial/scaffolding.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Note that, when we say GraphQL HTTP API, by default, we're referring to the one
2828

2929
<Alert type="info">
3030

31-
Learn more about the **API** project application on the cloud infrastructure level in the [Cloud Infrastructure](/docs/{version}/architecture/introduction) key topics section.
31+
Learn more about the **API** project application on the cloud infrastructure level in the [Cloud Infrastructure](/docs/architecture/introduction) key topics section.
3232

3333
</Alert>
3434

docs/developer-docs/5.29.x/core-development-concepts/scaffolding/extend-graphql-api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ You are free to create new tests in the similar fashion, or amend the existing o
223223

224224
Please note that, by default, the authentication and authorization logic isn't included in the generated code. In other words, all of the generated GraphQL query and mutation operations can be performed by anonymous (not logged-in) users, which is in most cases not the desired behavior.
225225

226-
Luckily, with a couple of built-in utilities, this can be relatively easily added. Please check out the [existing tutorials](/docs/{version}/admin-area/new-app-tutorial/security) to learn how to implement these on your own.
226+
Luckily, with a couple of built-in utilities, this can be relatively easily added. Please check out the [existing tutorials](/docs/admin-area/new-app-tutorial/security) to learn how to implement these on your own.
227227

228228
### I need more flexibility when it comes to data querying. Can I bring in a different database, for example ElasticSearch?
229229

docs/developer-docs/5.29.x/infrastructure/basics/modify-cloud-infrastructure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ export default createCoreApp({
197197

198198
### Defining Multiple Production Environments
199199

200-
Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/{version}/architecture/deployment-modes/production).
200+
Upon running the [`webiny deploy`](/docs/{version}/core-development-concepts/basics/project-deployment) command, when `prod` is passed as the environment name, a Webiny project is deployed in the so-called [production deployment mode](https://www.webiny.com/docs/architecture/deployment-modes/production).
201201

202202
On order to use the production deployment mode for environments other than `prod`, we can use the `productionEnvironments` parameter. The following example shows how we can use the production mode for the `staging` environment:
203203

0 commit comments

Comments
 (0)