Skip to content

Commit

Permalink
nick/prod 3187 p1 docs cleanupreorg (#402)
Browse files Browse the repository at this point in the history
* fix: deprecated info in release notes

* fix: remove outdated info in OIDC section

* chore: ordering FAQ directory to test new routing system

* fix: new routing system working properly for nested folders now

* fix: comment out plural pro pricing

* fix: correcting last commit

* fix: small typo in plural pricing plan

* chore: overhaul of routing and navigation, more archiving

* refactor: nav and routing overhaul + new hierarchy for docs

* fix: showing directories without pages in navbar

* checkpoint: first attempt at unifying routing and navigation systems

* fix: most internal links fixed, checkpoint

* chore: remove deprecated linik migration scripts

* chore: remove watch-route.ts to simplify and debug dev env

* fix: reverting improper changes to .eslintrc.js

* fix: remove accidentally created npm packages and files

* chore: styling on linter file

* fix: minor issue with doclink component being self-referential

* fix: linting errors

* fix: more linting errors fixed

* fix: more linting

* fix: outdated section of OIDC section

* fix: replacing links with relative links

* fix: hydration issue on the frontend resolved

* fix: some broken links resolved

* fix lint issues, align dev deps with marketing site

* fix: various doclink fixes

* fix: removing and changing outdated content and links on the homepage

* fix: removing unused code for linting

* bump nextjs to 14

* bump node version

* fix: make NavData.tsx use generated and not hard-coded nav structure

* fix: reimplement numbered prefix cleaning and sorted

* fix: generate routes now properly pulling from title frontmatter

* content: update titles in whole nav bar

* fix: many links corrected to align with live docs

* fix: docs.generated.ts being properly updated by script now

* chore: add proper id functionality to prevent dead links

* fix: remove test file

* fix: remove test file routing

* chore: remove deprecated systems for routing logic

* fix: linting fixes

* fix: add auto-gen files to prettier ignore, fix other linting issues

* feat: add snippets for doclinks

* content: title change for ai

---------

Co-authored-by: Jake Laderman <[email protected]>
  • Loading branch information
nickcernera and jsladerman authored Feb 20, 2025
1 parent efddfa6 commit 409519c
Show file tree
Hide file tree
Showing 129 changed files with 7,313 additions and 5,217 deletions.
2 changes: 2 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
src/routing/registry.ts
src/routing/navigation.ts
31 changes: 29 additions & 2 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,19 @@ module.exports = {
typescript: {}, // this loads <rootdir>/tsconfig.json to eslint
},
},
parser: '@typescript-eslint/parser',
parserOptions: {
project: './tsconfig.json',
project: true,
tsconfigRootDir: __dirname,
},
extends: ['@pluralsh/eslint-config-typescript', 'prettier'],
plugins: ['prettier'],
globals: {
JSX: true,
},
rules: {
'prettier/prettier': 'error',
'react/no-unknown-property': ['error', { ignore: ['css'] }],
'@typescript-eslint/consistent-type-exports': 'error',
'@typescript-eslint/consistent-type-imports': [
'error',
Expand Down Expand Up @@ -57,13 +62,35 @@ module.exports = {
],
},
],
'jsx-a11y/label-has-associated-control': [
2,
{
labelComponents: ['Label'],
controlComponents: ['Input'],
assert: 'either',
depth: 3,
},
],
},
// Disable TS parser and rules that depend on a parser for config files
overrides: [
{
files: ['.eslintrc.js', 'next.config.js', 'index-pages.mjs'],
files: [
'.eslintrc.js',
'next.config.js',
'tailwind.config.ts',
'postcss.config.js',
'codegen.ts',
'index-pages.mjs',
'next-sitemap.config.js',
],
parserOptions: {
project: null,
},
rules: {
'@typescript-eslint/consistent-type-exports': 'off',
'@typescript-eslint/consistent-type-imports': 'off',
},
},
],
}
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ node_modules/
!.yarn/releases
!.yarn/sdks
!.yarn/versions
npm-debug.log*
yarn-debug.log*
yarn-error.log*

Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
18.12.1
22.12.0
4 changes: 3 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,4 @@
/src/generated/
*.md
*.md
/src/routes/docs.generated.ts
/src/routing/navigation.ts
9 changes: 9 additions & 0 deletions .vscode/markdown.code-snippets
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"Documentation Link": {
"prefix": "doclink",
"body": [
"{% doclink to=\"${1|overview_introduction,overview_architecture,overview_api_reference,getting_started_first_steps,getting_started_first_steps_cli_quickstart,getting_started_first_steps_existing_cluster,getting_started_how_to_use,getting_started_how_to_use_mgmt_cluster,getting_started_how_to_use_rbac,getting_started_how_to_use_scm_connection,getting_started_how_to_use_workload_cluster,getting_started_how_to_use_controllers,getting_started_how_to_use_pr_automation,getting_started_how_to_use_microservice,getting_started_how_to_use_pipelines,getting_started_advanced_config,getting_started_advanced_config_sandboxing,getting_started_advanced_config_network_configuration,getting_started_advanced_config_private_ca,plural_features_continuous_deployment,plural_features_continuous_deployment_deployment_operator,plural_features_continuous_deployment_git_service,plural_features_continuous_deployment_helm_service,plural_features_continuous_deployment_global_service,plural_features_k8s_upgrade_assistant,plural_features_stacks_iac_management,plural_features_stacks_iac_management_customize_runners,plural_features_stacks_iac_management_pr_workflow,plural_features_stacks_iac_management_manual_runs,plural_features_stacks_iac_management_local_execution,plural_features_stacks_iac_management_custom_stacks,plural_features_stacks_iac_management_auto_cancellation,plural_features_stacks_iac_management_service_contexts,plural_features_service_catalog,plural_features_service_catalog_creation,plural_features_service_catalog_contribution_program,plural_features_kubernetes_dashboard,plural_features_plural_ai,plural_features_plural_ai_setup,plural_features_plural_ai_architecture,plural_features_plural_ai_cost,plural_features_pr_automation,plural_features_pr_automation_crds,plural_features_pr_automation_testing,plural_features_pr_automation_pipelines,plural_features_service_templating,plural_features_service_templating_templating_filters,plural_features_projects_and_multi_tenancy,plural_features_notifications,faq_security,faq_plural_oidc,faq_certifications,faq_paid_tiers,resources_release_notes|}\" %}${2:Link Text}{% /doclink %}"
],
"description": "Insert a doclink with route ID autocompletion"
}
}
2 changes: 1 addition & 1 deletion next-env.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
/// <reference types="next/image-types/global" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.
Loading

0 comments on commit 409519c

Please sign in to comment.