From 70b258df4936cb1bcb516fde5e3ce1a10c0b092e Mon Sep 17 00:00:00 2001 From: daknhh Date: Mon, 2 Sep 2024 15:34:17 +0200 Subject: [PATCH] Adjust Docs --- lib/tools/helpers/index.ts | 19 ++++++++++++++++++- static/docs/README.md | 23 +++++++++++++---------- static/docs/custom.css | 2 +- typedoc.json | 7 ++++--- 4 files changed, 36 insertions(+), 15 deletions(-) diff --git a/lib/tools/helpers/index.ts b/lib/tools/helpers/index.ts index 3adeb677..cc888c1e 100644 --- a/lib/tools/helpers/index.ts +++ b/lib/tools/helpers/index.ts @@ -1,4 +1,21 @@ - +/** + * @packageDocumentation + * # AWS Firewall Factory - Helper Functions + * + * This Helper Functions are used to provide the necessary functions to the AWS Firewall Factory. + * ## ๐Ÿงฐ Helpers: + * AWS Firewall Factory Helper (afwfHelper): Contains the necessary functions to print firewall factory information, etc. + * + * CloudFormation Helper (cloudformationHelper): Contians the necessary functions to get CloudFormation Stacks output etc. + * + * Web Application Firewall Helper (wafHelper): Contains the necessary functions to calculate WCUs for WebACLs, get Managed RuleGroups versions, etc. + * + * Pricing Helper (pricingHelper): Contains the necessary functions to get pricing information for WAF and Advanced Shield. + * + * Guidance Helper (guidanceHelper): Provides the necessary functions to get the guidance for AWS Firewall Factory that is printed to the console during deployment. + * + * SSM Helper (ssmHelper): Provides the necessary functions to retrieve parameters, etc. from the AWS SSM Parameter Store. +*/ export * as cloudformationHelper from "./cloudformation"; export * as wafHelper from "./web-application-firewall"; export * as afwfHelper from "./aws-firewall-factory"; diff --git a/static/docs/README.md b/static/docs/README.md index ec67872c..7d5dc106 100644 --- a/static/docs/README.md +++ b/static/docs/README.md @@ -1,5 +1,5 @@ -[๐Ÿ“ฆ Releases](https://github.com/globaldatanet/aws-firewall-factory/releases) - [๐Ÿ”– Imprint](https://globaldatanet.com/imprint) - [๐Ÿ“… Meeting](https://calendly.com/dakn/30min-1) - [๐Ÿšง Feature request](https://github.com/globaldatanet/aws-firewall-factory/issues/new?assignees=&labels=feature-request%2C+enhancement&template=feature_request.md&title=) | [๐Ÿ› Bug Report](https://github.com/globaldatanet/aws-firewall-factory/issues/new?assignees=&labels=bug%2C+triage&template=bug_report.md&title=) +[๐Ÿ“ฆ Releases](https://github.com/globaldatanet/aws-firewall-factory/releases) | [๐Ÿ”– Imprint](https://globaldatanet.com/imprint) | [๐Ÿ“… Meeting](https://calendly.com/dakn/30min-1) | [๐Ÿšง Feature request](https://github.com/globaldatanet/aws-firewall-factory/issues/new?assignees=&labels=feature-request%2C+enhancement&template=feature_request.md&title=) | [๐Ÿ› Bug Report](https://github.com/globaldatanet/aws-firewall-factory/issues/new?assignees=&labels=bug%2C+triage&template=bug_report.md&title=) ## โ‰๏ธ .What is a Web Application Firewall? @@ -12,18 +12,21 @@ An open-source solution that helps you **deploy, update and stage** your Web App It automates your security management, can be tailored with individual WAF configurations and alligns with **AWS best-practices**. - - **โ™พ๏ธ Fully automated to centralize your WAF Deployment & Management:** - It simplifies the entire process by minimising administrative effort. Making it easier for you to ensure consistent protection and overseeing your WAF across applications. +- **โ™พ๏ธ Fully automated to centralize your WAF Deployment & Management:** +It simplifies the entire process by minimising administrative effort. Making it easier for you to ensure consistent protection and overseeing your WAF across applications. - - **๐Ÿ›ก๏ธ Fully automated to centralize your Advanced Shield Policy Deployment:** - Supports deployment of AWS Advanced Shield Policy through AWS Firewall Manager. You can now seamlessly protect your resources fom DDoS attacks across your accounts in a centralised manner. +- **๐Ÿ›ก๏ธ Fully automated to centralize your Advanced Shield Policy Deployment:** +Supports deployment of AWS Advanced Shield Policy through AWS Firewall Manager. You can now seamlessly protect your resources fom DDoS attacks across your accounts in a centralised manner. + +- **๐Ÿ”– Comprehensive Testing with Detailed Reports:** +It uncovers wether your application is resilient or not and reports issues precisely. With these insights you can dive deep into strengthening your applicationโ€™s weaknesses. + +- **๐Ÿงฎ Automate Calculation of Your WAF's Costs:** +Your smart assistant that overtakes cost estimations in a transparent way, helping you associate expenses to the exact security measures. This will **boost your financial planning.** - - **๐Ÿ”– Comprehensive Testing with Detailed Reports:** - It uncovers wether your application is resilient or not and reports issues precisely. With these insights you can dive deep into strengthening your applicationโ€™s weaknesses. - - **๐Ÿงฎ Automate Calculation of Your WAF's Costs:** - Your smart assistant that overtakes cost estimations in a transparent way, helping you associate expenses to the exact security measures. This will **boost your financial planning.** - **๐Ÿ’Œ Notifications about Ddos or Managed Rule Group Changes:** - Get notified about potential DDoS activity for protected resources or changes in AWS managed rule groups, such as upcoming new versions and urgent security updates. +Get notified about potential DDoS activity for protected resources or changes in AWS managed rule groups, such as upcoming new versions and urgent security updates. + - โœ… **Additional features such as centralized dashboards and logging:** Monitor every security event in real time to be able to defend against potential threads and anomalies immediately. diff --git a/static/docs/custom.css b/static/docs/custom.css index 25d18cb7..1f719457 100644 --- a/static/docs/custom.css +++ b/static/docs/custom.css @@ -4,4 +4,4 @@ } a { color: #00ecbd -} +} \ No newline at end of file diff --git a/typedoc.json b/typedoc.json index 56c5e2d6..97a36109 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,13 +1,14 @@ { "$schema": "https://typedoc.org/schema.json", - "entryPoints": ["lib/_shield-advanced/index.ts","lib/_waf/index.ts","lib/_prerequisites/index.ts","lib/types/config.ts", "lib/types/runtimeprops.ts", "lib/types/enums.ts", "lib/types/fms.ts", "node_modules/aws-cdk-lib/core/lib/cfn-tag.d.ts", "node_modules/aws-cdk-lib/core/lib/tag-manager.d.ts", "lib/constructs/shield_Dashboard/index.ts", "lib/constructs/waf_Dashboard/index.ts", "lib/tools/helpers/index.ts"], + "entryPoints": ["lib/_shield-advanced/index.ts","lib/_waf/index.ts","lib/_prerequisites/index.ts","lib/types/config.ts", "lib/types/runtimeprops.ts", "lib/types/enums.ts", "lib/types/fms.ts", "node_modules/aws-cdk-lib/core/lib/cfn-tag.d.ts", "node_modules/aws-cdk-lib/core/lib/tag-manager.d.ts", "lib/constructs/shieldDashboard/index.ts", "lib/constructs/wafDashboard/index.ts", "lib/tools/helpers/index.ts"], "readme": "./static/docs/README.md", "customCss": "./static/docs/custom.css", - "name": "AWS Firewall Factory Documentation", + "name": "AWS Firewall Factory", "entryPointStrategy": "Expand", "exclude": ["**/gotestwaf/**","**/bin/**","**/values/**","**/lambda/**","**/adaptivecards/**"], "plugin": ["typedoc-plugin-extras"], "favicon": "static/icon/aws_firewall_factory_favicon.ico", + "searchInDocuments": true, "searchInComments": true, "hideGenerator": true, "navigation": { @@ -25,5 +26,5 @@ "Property", "Method" ], - "includeVersion": true + "includeVersion": true, }