Commit 4505cd9
Premium preview merge master (#655)
* fix: update TOC item access in DocTemplate component
- Modified the condition for accessing TOC items to ensure it handles undefined cases correctly.
- Updated the dependency array in the useMemo hook to include the entire toc object for better stability in TOC data generation.
* feat: add support for premium slug in generateConfig function (#647)
* feat: add support for premium slug in generateConfig function
- Introduced a new condition to handle slugs that include "premium/", allowing for better categorization in the configuration generation process.
* refactor: update CloudPlan import paths across components
- Replaced imports of CloudPlan from "shared/useCloudPlan" to "shared/interface" for consistency and clarity.
- Adjusted related components to ensure proper usage of the updated CloudPlan type definition.
* feat: extend EXTENDS_FOLDERS to include premium plan
- Updated the EXTENDS_FOLDERS constant to include "premium" as a valid CloudPlan option, enhancing the flexibility of the table of contents generation.
- Adjusted the type definition to ensure consistency with the new CloudPlan import.
* feat: add CloudPlan type to path.ts for enhanced configuration
- Imported CloudPlan into path.ts to support additional configuration options.
- Updated the prefix variable type to CloudPlan | undefined for improved type safety in the generateConfig function.
* feat: restructure page creation logic by modularizing create-pages functionality
- Removed the existing create-pages.ts file and replaced it with modular files for creating specific pages: create-docs, create-doc-home, create-cloud-api, create-search, and create-404.
- Introduced an interface file to define common types and constants, enhancing code organization and maintainability.
- Each new file encapsulates the logic for creating its respective page, improving clarity and separation of concerns in the page generation process.
* refactor: simplify prefix determination in generateConfig function
- Replaced multiple conditional checks for slug prefixes with a more concise approach using an array and the find method.
- Maintained the existing logic for handling the dedicated prefix based on the presence of a name, improving code readability and maintainability.
* fix: update template import paths in page creation files
- Adjusted the import paths for template files in create-404, create-cloud-api, create-doc-home, create-docs, and create-search to ensure correct resolution.
- Enhanced consistency across page creation logic by standardizing the path structure.
* chore: add disk usage checks throughout production workflow
- Introduced disk usage checks at various stages of the production workflow to monitor system resource usage.
- Added checks after Docker image cleanup, node setup, dependency installation, cache restoration, and before/after deployment steps for better resource management.
* chore: enhance production workflow by maximizing build space
- Added a step to maximize build space using the easimon/maximize-build-space action, allowing for better resource management during builds.
- Included additional disk usage checks to monitor space before and after the build process, improving overall workflow efficiency.
* refactor: streamline production workflow commands for clarity
- Consolidated multiple run commands into single block executions for installing dependencies and purging CDN cache, enhancing readability and maintainability of the workflow script.
* chore: rename markdown source in gatsby-config for consistency
- Updated the name of the markdown source from `markdown-pages1` to `markdown-pages` for improved clarity and consistency in the configuration.
* refactor: optimize disk space management in production workflow
- Removed redundant disk usage checks and consolidated cleanup commands into a single run step to streamline the production workflow.
- Enhanced disk space management by directly removing unnecessary directories and pruning Docker images, improving build efficiency.
* Update sentry sample rate (#650)
* chore: adjust tracesSampleRate in Sentry configuration for improved performance
* fix: improve node removal safety in useTotalContributors hook
* fix: correct dependency array in TabContentDetector to ensure proper rendering behavior
* fix: enhance TabContentDetector to prevent duplicate rendering of tabs
- Added renderedTabs prop to SimpleTab and TabContentDetector components.
- Updated useEffect in TabContentDetector to check if the tab has already been rendered, ensuring proper rendering behavior and preventing duplicate calls to onRendered.
* feat: update HeaderNav to conditionally render cloud plan links
- Integrated useCloudPlan hook to retrieve the current cloud plan.
- Modified navigation links in HeaderNavStack and HeaderNavStackMobile to dynamically adjust the URL based on the cloud plan, enhancing user experience.
* fix: correct optional chaining in filterRightToc function
- Removed optional chaining for item.items to ensure proper filtering of nested items in the filterRightToc function, enhancing functionality.
* fix: update HeaderNav links to handle undefined cloud plans
- Modified the navigation links in HeaderNavStack and HeaderNavStackMobile to include a condition that allows for rendering the default URL when the cloud plan is undefined, improving user experience and navigation reliability.
* src, static: update cn.pingcap.com links (#652)
* tweak: remove pingcap account track script (#654)
* Adjust TOC to support the same article linking from multiple locations (#653)
* feat: enhance navigation state management with session storage
- Updated the LeftNavTree component to support saving and retrieving navigation item IDs from session storage, improving user experience by maintaining state across sessions.
- Modified the calcExpandedIds function to accept an optional targetId for more precise matching.
- Implemented helper functions to handle session storage interactions for navigation items.
* refactor: simplify navigation state management in LeftNavTree component
- Removed session storage interactions for expanded and selected navigation items, streamlining state management.
- Updated the calcExpandedIds function calls to eliminate unnecessary parameters, enhancing clarity and performance.
* refactor: simplify scroll behavior in scrollToElementIfInView function
- Updated the scrollToElementIfInView function to directly call scrollIntoView with a "center" block option, removing unnecessary viewport checks and improving code clarity.
* refactor: reorganize imports and streamline createDocs function
- Updated import paths for clarity and consistency.
- Removed unused navigation URL generation functions to simplify the createDocs logic.
- Introduced a default value for inDefaultPlan to enhance code readability.
* refactor: simplify HeaderNav links by removing cloud plan conditions
- Removed cloud plan checks from navigation links in HeaderNavStack and HeaderNavStackMobile, streamlining the URL generation for the TiDB Cloud link.
- Cleaned up unused imports related to cloud plan management for improved code clarity.
* refactor: update createDocHome to target new documentation path
- Changed the regex filter in createDocHome to point to the updated documentation file path for TiDB Cloud.
- Removed unused navigation URL generation functions to streamline the code and improve clarity.
---------
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: WD <me@wangdi.ink>1 parent 87d7b28 commit 4505cd9
File tree
29 files changed
+354
-309
lines changed- .github/workflows
- gatsby
- create-pages
- scripts
- src
- components
- Contributors
- Layout
- MDXComponents
- templates
- static/zh
29 files changed
+354
-309
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
43 | 49 | | |
44 | 50 | | |
45 | 51 | | |
| |||
63 | 69 | | |
64 | 70 | | |
65 | 71 | | |
66 | | - | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
67 | 75 | | |
68 | 76 | | |
69 | 77 | | |
| |||
195 | 203 | | |
196 | 204 | | |
197 | 205 | | |
198 | | - | |
| 206 | + | |
| 207 | + | |
199 | 208 | | |
200 | 209 | | |
201 | 210 | | |
Submodule docs updated 2679 files
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
4 | | - | |
5 | 3 | | |
6 | 4 | | |
7 | 5 | | |
| |||
19 | 17 | | |
20 | 18 | | |
21 | 19 | | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
0 commit comments