Merge pull request #7092 from Himangini/doc-home-page

Docs Landing page
eksctl-io · Sep 29, 2023 · fafde29 · fafde29
2 parents 16eb091 + d1369fc
commit fafde29
Show file tree

Hide file tree

Showing 17 changed files with 1,056 additions and 405 deletions.
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -32,7 +32,7 @@ template: |
   Weaveworks would like to sincerely thank:
   $CONTRIBUTORS
 replacers:
-  - search: '/@(Himangini|TiberiuGC|A-Hilaly|yuxiang-zhang|cPu1|eksctl-bot|dependabot(?:\[bot\])?)(?:,| |$)/gm'
+  - search: '/@(Himangini|TiberiuGC|a-hilaly|yuxiang-zhang|cPu1|eksctl-bot|dependabot(?:\[bot\])?)(?:,| |$)/gm'
     replace: ''
 exclude-labels:
   - 'skip-release-notes'
diff --git a/COMMUNITY.md b/COMMUNITY.md
@@ -16,7 +16,7 @@ Ready to start contributing? Head over to our [contribution docs](CONTRIBUTING.m
 
 The core team of maintainers are Chetan Patwal ([@cPu1](https://github.com/cPu1)),
 Tiberiu Copaciu ([@TiberiuGC](https://github.com/TiberiuGC)),
-Amine Hilaly ([@A-Hilaly](https://github.com/a-hilaly)),
+Amine Hilaly ([@a-hilaly](https://github.com/a-hilaly)),
 Yu Xiang Zhang ([@yuxiang-zhang](https://github.com/yuxiang-zhang))
 and Himangini Daware ([@Himangini](https://github.com/Himangini)).
 

diff --git a/README.md b/README.md
@@ -14,6 +14,29 @@ _Need help? Join [Eksctl Slack][slackjoin]._
 
 `eksctl` is available to install from official releases as described below. We recommend that you install `eksctl` from only the official GitHub releases. You may opt to use a third-party installer, but please be advised that AWS does not maintain nor support these methods of installation. Use them at your own discretion.
 
+### Prerequisite
+
+You will need to have AWS API credentials configured. What works for AWS CLI or any other tools (kops, Terraform, etc.) should be sufficient. You can use [`~/.aws/credentials` file][awsconfig]
+or [environment variables][awsenv]. For more information read [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-environment.html).
+
+[awsenv]: https://docs.aws.amazon.com/cli/latest/userguide/cli-environment.html
+[awsconfig]: https://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html
+
+You will also need [AWS IAM Authenticator for Kubernetes](https://github.com/kubernetes-sigs/aws-iam-authenticator) command (either `aws-iam-authenticator` or `aws eks get-token` (available in version 1.16.156 or greater of AWS CLI) in your `PATH`.
+
+The IAM account used for EKS cluster creation should have these minimal access levels.
+
+| AWS Service      | Access Level                                           |
+|------------------|--------------------------------------------------------|
+| CloudFormation   | Full Access                                            |
+| EC2              | **Full:** Tagging **Limited:** List, Read, Write       |
+| EC2 Auto Scaling | **Limited:** List, Write                               |
+| EKS              | Full Access                                            |
+| IAM              | **Limited:** List, Read, Write, Permissions Management |
+| Systems Manager  | **Limited:** List, Read                                |
+
+The inline policy json is listed in [Minimal IAM Policies](https://eksctl.io/usage/minimum-iam-policies/).
+
 ### For Unix
 
 To download the latest release, run:
@@ -114,29 +137,6 @@ choco install eksctl
 scoop install eksctl
 ```
 
-## Prerequisite
-
-You will need to have AWS API credentials configured. What works for AWS CLI or any other tools (kops, Terraform, etc.) should be sufficient. You can use [`~/.aws/credentials` file][awsconfig]
-or [environment variables][awsenv]. For more information read [AWS documentation](https://docs.aws.amazon.com/cli/latest/userguide/cli-environment.html).
-
-[awsenv]: https://docs.aws.amazon.com/cli/latest/userguide/cli-environment.html
-[awsconfig]: https://docs.aws.amazon.com/cli/latest/userguide/cli-config-files.html
-
-You will also need [AWS IAM Authenticator for Kubernetes](https://github.com/kubernetes-sigs/aws-iam-authenticator) command (either `aws-iam-authenticator` or `aws eks get-token` (available in version 1.16.156 or greater of AWS CLI) in your `PATH`.
-
-The IAM account used for EKS cluster creation should have these minimal access levels.
-
-| AWS Service      | Access Level                                           |
-|------------------|--------------------------------------------------------|
-| CloudFormation   | Full Access                                            |
-| EC2              | **Full:** Tagging **Limited:** List, Read, Write       |
-| EC2 Auto Scaling | **Limited:** List, Write                               |
-| EKS              | Full Access                                            |
-| IAM              | **Limited:** List, Read, Write, Permissions Management |
-| Systems Manager  | **Limited:** List, Read                                |
-
-The inline policy json is listed in [Minimal IAM Policies](https://eksctl.io/usage/minimum-iam-policies/).
-
 ## Basic usage
 
 To create a basic cluster, run:

diff --git a/userdocs/src/README.md → userdocs/README.md b/userdocs/src/README.md → userdocs/README.md
diff --git a/userdocs/mkdocs.yml b/userdocs/mkdocs.yml
@@ -44,6 +44,8 @@ theme:
       - navigation.instant
       - navigation.sections
       - navigation.top
+      - navigation.tabs
+      - navigation.tabs.sticky
       - search.highlight
       - search.share
       - search.suggest
@@ -107,6 +109,8 @@ extra_css:
 
 extra_javascript:
   - https://cdn.jsdelivr.net/npm/@glidejs/glide
+  - https://cdnjs.cloudflare.com/ajax/libs/axios/0.21.1/axios.min.js
+  - javascripts/extra.js
 
 # Extensions
 markdown_extensions:
@@ -127,64 +131,67 @@ markdown_extensions:
 
 # Page tree
 nav:
-  - Introduction: introduction.md
+  - Home: index.md
+  - Getting Started:
+      - Introduction: getting-started.md
+      - Installation: installation.md
+      - Announcements:
+        - announcements/managed-nodegroups-announcement.md
+        - announcements/nodegroup-override-announcement.md
   - Usage:
-      - Clusters:
-          - usage/creating-and-managing-clusters.md
-          - usage/outposts.md
-          - usage/unowned-clusters.md
-          - usage/eks-connector.md
-          - usage/customizing-the-kubelet.md
-          - usage/cloudwatch-cluster-logging.md
-          - usage/eks-private-cluster.md
-          - usage/addons.md
-          - usage/emr-access.md
-          - usage/fargate-support.md
-          - usage/cluster-upgrade.md
-          - usage/addon-upgrade.md
-      - Nodegroups:
-          - usage/managing-nodegroups.md
-          - usage/nodegroup-upgrade.md
-          - usage/nodegroup-with-custom-subnet.md
-          - usage/nodegroup-customize-dns.md
-          - usage/nodegroup-taints.md
-          - usage/eks-managed-nodes.md
-          - usage/launch-template-support.md
-          - usage/instance-selector.md
-          - usage/spot-instances.md
-          - usage/gpu-support.md
-          - usage/arm-support.md
-          - usage/autoscaling.md
-          - usage/custom-ami-support.md
-          - usage/container-runtime.md
-          - usage/windows-worker-nodes.md
-          - usage/nodegroup-additional-volume-mappings.md
-      - GitOps:
-          - usage/gitops-v2.md
-      - Security:
-          - usage/security.md
-          - usage/kms-encryption.md
-      - Networking:
-          - usage/vpc-networking.md
-          - usage/vpc-configuration.md
-          - usage/vpc-subnet-settings.md
-          - usage/vpc-cluster-access.md
-          - usage/vpc-ip-family.md
-      - IAM:
-          - usage/minimum-iam-policies.md
-          - usage/iam-permissions-boundary.md
-          - usage/iam-policies.md
-          - usage/iam-identity-mappings.md
-          - usage/iamserviceaccounts.md
-      - usage/dry-run.md
-      - usage/schema.md
-      - usage/eksctl-anywhere.md
-      - usage/eksctl-karpenter.md
-      - usage/troubleshooting.md
-      - FAQ: usage/faq.md
-  - Announcements:
-    - announcements/managed-nodegroups-announcement.md
-    - announcements/nodegroup-override-announcement.md
+    - Clusters:
+      - usage/creating-and-managing-clusters.md
+      - usage/outposts.md
+      - usage/unowned-clusters.md
+      - usage/eks-connector.md
+      - usage/customizing-the-kubelet.md
+      - usage/cloudwatch-cluster-logging.md
+      - usage/eks-private-cluster.md
+      - usage/addons.md
+      - usage/emr-access.md
+      - usage/fargate-support.md
+      - usage/cluster-upgrade.md
+      - usage/addon-upgrade.md
+    - Nodegroups:
+      - usage/managing-nodegroups.md
+      - usage/nodegroup-upgrade.md
+      - usage/nodegroup-with-custom-subnet.md
+      - usage/nodegroup-customize-dns.md
+      - usage/nodegroup-taints.md
+      - usage/eks-managed-nodes.md
+      - usage/launch-template-support.md
+      - usage/instance-selector.md
+      - usage/spot-instances.md
+      - usage/gpu-support.md
+      - usage/arm-support.md
+      - usage/autoscaling.md
+      - usage/custom-ami-support.md
+      - usage/container-runtime.md
+      - usage/windows-worker-nodes.md
+      - usage/nodegroup-additional-volume-mappings.md
+    - GitOps:
+      - usage/gitops-v2.md
+    - Security:
+      - usage/security.md
+      - usage/kms-encryption.md
+    - Networking:
+      - usage/vpc-networking.md
+      - usage/vpc-configuration.md
+      - usage/vpc-subnet-settings.md
+      - usage/vpc-cluster-access.md
+      - usage/vpc-ip-family.md
+    - IAM:
+      - usage/minimum-iam-policies.md
+      - usage/iam-permissions-boundary.md
+      - usage/iam-policies.md
+      - usage/iam-identity-mappings.md
+      - usage/iamserviceaccounts.md
+    - usage/dry-run.md
+    - usage/schema.md
+    - usage/eksctl-anywhere.md
+    - usage/eksctl-karpenter.md
+    - usage/troubleshooting.md
+    - FAQ: usage/faq.md
   - Examples: "https://github.com/eksctl-io/eksctl/tree/main/examples"
   - Community: community.md
   - Adopters: adopters.md
diff --git a/userdocs/src/adopters.md b/userdocs/src/adopters.md
@@ -1,3 +1,7 @@
+---
+hide:
+  - navigation
+---
 # eksctl Adopters :fontawesome-solid-handshake-simple:
 
 Are you and your organisation using `eksctl`?

diff --git a/userdocs/src/community.md b/userdocs/src/community.md
@@ -1,6 +1,11 @@
+---
+hide:
+  - navigation
+---
 # eksctl Community :fontawesome-solid-people-group:
 
-For more information, please head to our [Community][community] and [Contributing][contributing] docs in Github. :octicons-heart-fill-24:{ .heart }
+We welcome contributions from the community. :octicons-heart-fill-24:{ .heart }
+For more information, please head to our [Community][community] and [Contributing][contributing] docs in Github.
 
 [community]: https://github.com/eksctl-io/eksctl/blob/main/COMMUNITY.md
 [contributing]: https://github.com/eksctl-io/eksctl/blob/main/CONTRIBUTING.md