Skip to content

Commit b4f65ae

Browse files
authored
Brand updates (#115)
* Update Logo & Favicon * Update Introduction page * Update documentation-nav * Update overview page * Update getstarted-overview * Update cloudplaform page * Update templates introduction * Update templates FAQ * Update cloud introduction page & nav * Update OSS vs Cloud page * Update cloud integrations * Update cloud adding assets page * Update scanning parameters page * Update Editor overview * Update Editor AI page * Update Editor recommended page * Update cloud FAQs page * Update cloud settings page * Update API Introduction page
1 parent d2cecef commit b4f65ae

23 files changed

+153
-115
lines changed

api-reference/introduction.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
---
22
title: "Cloud API Reference Introduction"
3-
description: 'Details on the ProjectDiscovery Cloud Platform API'
3+
description: 'Details on the ProjectDiscovery API'
44
sidebarTitle: 'Introduction'
55
---
66

77
## Overview
88

9-
The ProjectDiscovery Cloud Platform API v1 is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has resource-oriented URLs, accepts and returns JSON in most cases, and the API uses standard HTTP response codes, authentication, and verbs. Our API also conforms to the [OpenAPI Specification](https://www.openapis.org/).
9+
The ProjectDiscovery API v1 is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has resource-oriented URLs, accepts and returns JSON in most cases, and the API uses standard HTTP response codes, authentication, and verbs. Our API also conforms to the [OpenAPI Specification](https://www.openapis.org/).
1010

1111
This API documentation will walk you through each of the available resources, and provides code examples for `cURL`, `Python`, `JavaScript`, `PHP`, `Go` and `Java`. Each endpoint includes the required authorization information and parameters, and provides examples of the response you should expect.
1212

1313
## Authentication
1414

15-
The ProjectDiscovery Cloud Platform API uses API keys to authenticate requests. You can view and manage your API key in ProjectDiscovery Cloud Platform at https://cloud.projectdiscovery.io/ under your user information.
15+
The ProjectDiscovery API uses API keys to authenticate requests. You can view and manage your API key in ProjectDiscovery at https://cloud.projectdiscovery.io/ under your user information.
1616

17-
Authentication with the API is performed using a custom request header - `X-Api-Key` - which should simply be the value of your API key found with your ProjectDiscovery Cloud Platform account.
17+
Authentication with the API is performed using a custom request header - `X-Api-Key` - which should simply be the value of your API key found with your ProjectDiscovery account.
1818

1919
You must make all API calls over `HTTPS`. Calls made over plain HTTP will fail, as will requests without authentication or without all required parameters.
2020

2121
## Resources
22-
Below (and in the menu on the left) you can find the various resources available to the ProjectDiscovery Cloud Platform API.
22+
Below (and in the menu on the left) you can find the various resources available to the ProjectDiscovery API.
2323

2424
<CardGroup cols={2}>
2525
<Card

cloud/admin.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: "ProjectDiscovery Cloud Platform Settings & Administration "
2+
title: "Settings & Administration "
33
description: "Review administrative, team, and account settings"
44
sidebarTitle: "System Settings"
55
---
66

77
## Summary
88

9-
This guide covers general account administration under settings in the ProjectDiscovery Cloud Platform (PDCP). These administrative and system settings include details about your account, team settings for administrators, and password/2FA.
9+
This guide covers general account administration under settings in our cloud platform. These administrative and system settings include details about your account, team settings for administrators, and password/2FA.
1010

1111
If you have questions about settings that are not covered here, or functionality that you think would be helpful - [get in touch.](/help)
1212

@@ -39,7 +39,7 @@ To modify team settings select a team from the global navigation to display thos
3939

4040
### User Types
4141

42-
ProjectDiscovery Cloud Platform supports four types of users with the following permissions:
42+
ProjectDiscovery supports four types of users with the following permissions:
4343

4444
- Owner: Read, write, invite, billing
4545
- Admin: Read, write, invite

cloud/assets/adding-assets.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "Adding Assets"
3-
description: "Learn how to add and manage assets in ProjectDiscovery Cloud Platform"
3+
description: "Learn how to add and manage assets in ProjectDiscovery"
44
sidebarTitle: "Adding Assets"
55
---
66

77
## Overview
88

9-
Assets in ProjectDiscovery Cloud Platform can be any hosts you want to monitor - URLs, IP addresses, or CIDR ranges. There are three primary methods to add assets:
9+
Assets in our cloud platform can be any hosts you want to monitor - URLs, IP addresses, or CIDR ranges. There are three primary methods to add assets:
1010

1111
<CardGroup cols={3}>
1212
<Card

cloud/editor/ai.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "AI Assistance"
3-
description: "Review details on using AI to help generate templates for Nuclei and PDCP"
3+
description: "Review details on using AI to help generate templates for Nuclei and ProjectDiscovery"
44
---
55

66
<img src="/images/ai.jpg" alt="AI Prompt" width="800px" />

cloud/editor/overview.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ sidebarTitle: "Overview"
55
---
66
<Tip>For more in-depth information about Nuclei templates, including details on template structure and supported protocols [check out](/templates/introduction).</Tip>
77

8-
[The Template Editor](https://cloud.projectdiscovery.io) is a multi-functional cloud-hosted tool designed for creating, running, and sharing templates (Nuclei and ProjectDiscovery Cloud Platform). It's packed with helpful features for individual and professional users seeking to manage and execute templates.
8+
[The Template Editor](https://cloud.projectdiscovery.io/public/public-template) is a multi-functional cloud-hosted tool designed for creating, running, and sharing templates (Nuclei and ProjectDiscovery). It's packed with helpful features for individual and professional users seeking to manage and execute templates.
99

1010
![Templates Editor](/images/editor.jpg)
1111

1212

1313
## Template Compatibility
1414

15-
In addition to the Template Editor, ProjectDiscovery Cloud Platform(PDCP) supports any templates compatible with [Nuclei](nuclei/overview). These templates are exactly the same powerful YAML format supported in open source.
15+
In addition to the Template Editor, our cloud platform supports any templates compatible with [Nuclei](nuclei/overview). These templates are exactly the same powerful YAML format supported in open source.
1616

1717
Take a look at our [Templates](/Templates/introduction) documentation for a wealth of resources available around template design, structure, and how they can be customized to meet an enormous range of use cases. As always, if you have questions [we're here to help](/help/home).
1818
## Features
@@ -30,7 +30,7 @@ Current and upcoming features:
3030
| **AI Assistance** | Employ AI to craft Nuclei Templates based on the context of specified vulnerabilities. This feature simplifies template creation and tailors them to minimize the time required for creation. | Free \* |
3131
| **Scan (LIST, CIDR, ASN)** | In the professional version, run scans on target lists, network ranges (CIDR), AS numbers (ASN). | Teams |
3232
| **REST API** | In the professional version, fetch templates, call the AI, and perform scans remotely using APIs. | Teams |
33-
| **PDCP Sync** | Sync your generated templates with the ProjectDiscovery Cloud Platform for easy access and management, available in the professional version. | Teams |
33+
| **PDCP Sync** | Sync your generated templates with our cloud platform for easy access and management, available in the professional version. | Teams |
3434

3535
## Free Feature Limitations
3636

@@ -43,7 +43,7 @@ The limitations, reset daily, ensure system integrity and availability while pro
4343

4444
## How to Get Started
4545

46-
Begin by ensuring you have an account. If not, sign up on [https://cloud.projectdiscovery.io](https://cloud.projectdiscovery.io/) and follow the steps below:
46+
Begin by ensuring you have an account. If not, sign up on [https://cloud.projectdiscovery.io](https://cloud.projectdiscovery.io/sign-up) and follow the steps below:
4747

4848
1. Log in to your account at [https://cloud.projectdiscovery.io](https://cloud.projectdiscovery.io).
4949
2. Click on the "**Create new template**" button to open up a fresh editor.

cloud/editor/recommended.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
---
22
title: "Recommended"
3-
description: "Learn more about using Recommended Templates in PDCP (Teams)"
3+
description: "Learn more about using recommended templates with ProjectDiscovery"
44
---
55

66
<Info>
7-
The functionality described on this page is **only** available through
8-
[ProjectDiscovery Cloud Platform Teams](https://projectdiscovery.io/pricing).
7+
The functionality described on this page is **only** available on
8+
[ProjectDiscovery team account](https://projectdiscovery.io/pricing).
99
</Info>
1010

1111
## Overview
1212

13-
When setting up a scan in ProjectDiscovery Cloud Platform (PDCP) you have the option to build your scan using custom templates, [all templates](https://github.com/projectdiscovery/nuclei-templates), or recommended templates.
13+
When setting up a scan in our cloud platform you have the option to build your scan using custom templates, [all templates](https://github.com/projectdiscovery/nuclei-templates), or recommended templates.
1414

1515
**Recommended templates are a curated subset of the full template library designed for efficiently scanning your attack surface.**
1616

1717
This subset of templates, nearly 4000 in total, focuses on relevant and exploitable vulnerabilities, excluding informational templates and templates with the potential to generate false positives.
1818

19-
The curated set of Recommended templates is available as a config file and can be viewed in the Nuclei repository - [Recommended Templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml), or withing the application.
19+
The curated set of recommended templates is available as a config file and can be viewed in the Nuclei repository - [recommended templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml), or withing the application.
2020

21-
Rather than a list, PDCP's Recommended templates are curated through defined filters.
21+
Rather than a list, recommended templates are curated through defined filters.
2222

2323
_This approach ensures that the curated list remains up-to-date as new templates are added._
2424

25-
Filtering for Recommended templates includes:
25+
Filtering for recommended templates includes:
2626

2727
- All template severities except info
2828

2929
- Type: http, tcp, or javascript
3030

3131
- Exclusion of the tags: tech, dos, fuzz, creds-stuffing, token-spray, osint
3232

33-
- Exclusion of specific templates the list is available for review here --> [Recommended Templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml)
33+
- Exclusion of specific templates the list is available for review here --> [recommended templates](https://github.com/projectdiscovery/nuclei-templates/blob/main/config/recommended.yml)
3434

3535
<Note>
3636
If you have questions, reach out to us through [email protected].

cloud/general-faq.mdx

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,8 @@
11
---
2-
title: "PDCP FAQ"
3-
description: "Frequently Asked Questions about ProjectDiscovery Cloud Platform"
2+
title: "Frequently Asked Questions"
43
sidebarTitle: "FAQ"
54
---
65

7-
<Tip>
8-
Sign up for [ProjectDiscovery Cloud
9-
Platform](https://cloud.projectdiscovery.io/)
10-
</Tip>
11-
12-
## Summary
13-
14-
Check out the Frequently Asked Questions on this page to learn about general usage for ProjectDiscovery Cloud Platform (PDCP). We cover topics around data, system settings and administration, and pricing info.
15-
16-
### Other FAQs
17-
18-
Are you looking for details about certain features? Check out our feature-specific FAQs for additional details.
19-
20-
- [Assets FAQ](cloud/assets/overview#faq)
21-
- [Scanning FAQ](/cloud/scanning/overview#faq)
22-
- [Nuclei Templates FAQ](/cloud/editor/faq)
23-
24-
Questions about the product that you don't see covered here - we want to know!
25-
Contact [email protected] with any recommendations or issues.
266

277
## General
288

@@ -36,7 +16,7 @@ You can find our [terms of use](https://projectdiscovery.io/terms) here.
3616

3717
<Accordion title="Are there use cases that are prohibited?">
3818

39-
Our Cloud Platform is engineered for security and DevOps teams. Please include scan headers, whitelist your scan activities with your IT team, and limit scanning to authorized assets.
19+
ProjectDiscovery is engineered for security and DevOps teams. Please include scan headers, whitelist your scan activities with your IT team, and limit scanning to authorized assets.
4020

4121
If you have questions, don't hesitate to reach out - [email protected]!
4222

@@ -46,15 +26,13 @@ _Note: Unauthorized scans that lead to abuse reports will result in account susp
4626

4727
<Accordion title="What browsers are supported?">
4828

49-
ProjectDiscovery Cloud Platform works best on chromium-based browsers.
29+
ProjectDiscovery works best on chromium-based browsers.
5030

5131
</Accordion>
5232

5333
<Accordion title="How do I get support?">
5434

55-
For questions about ProjectDiscovery Cloud Platform first we recommend exploring our Documentation. Trigger our AI-based search with a question or phrase.
56-
57-
If you can't find what you need here - [email us](mailto:[email protected]), we're here to help!
35+
If you can't find what you need in our documentation - [email us](mailto:[email protected]), we're here to help!
5836

5937
</Accordion>
6038

@@ -72,16 +50,16 @@ This also applies to any information entered into our [AI template editor](/clou
7250

7351
</Accordion>
7452

75-
<Accordion title="Where does ProjectDiscovery Cloud Platform data reside?">
53+
<Accordion title="Where does ProjectDiscovery data reside?">
7654

77-
ProjectDiscovery Cloud Platform data resides with our cloud infrastructure partners. We maintain several relationships with leading global cloud providers.
55+
ProjectDiscovery data resides with our cloud infrastructure partners. We maintain several relationships with leading global cloud providers.
7856
We are SOC 2 compliant and our latest security reports can be requested from our Trust Center at security.projectdiscovery.io.
7957

8058
</Accordion>
8159

82-
<Accordion title="Can I self-host ProjectDiscovery Cloud Platform?">
60+
<Accordion title="Can I self-host ProjectDiscovery?">
8361

84-
We are working on an on-prem version of our Cloud Platform. Get in touch with us at [email protected] to share more about your requirements and learn about our product roadmap for upcoming features.
62+
We are working on an on-prem version of our cloud platform. Get in touch with us at [[email protected]](mailto:[email protected]) to share more about your requirements and learn about our product roadmap for upcoming features.
8563

8664
</Accordion>
8765

@@ -133,3 +111,14 @@ For existing users, visit **Settings –> Billing** to set up your subscription.
133111
Our primary payment method is via credit card invoiced in USD. For ACH payments or other custom payment requirements, please reach out to [[email protected]](mailto:[email protected]).
134112
</Accordion>
135113
</AccordionGroup>
114+
115+
## Other FAQs
116+
117+
Are you looking for details about certain features? Check out our feature-specific FAQs for additional details.
118+
119+
- [Assets FAQ](/cloud/assets/overview)
120+
- [Scanning FAQ](/cloud/scanning/overview)
121+
- [Nuclei Templates FAQ](/cloud/editor/faq)
122+
123+
Questions about the product that you don't see covered here - we want to know!
124+
Contact [email protected] with any recommendations or issues.

0 commit comments

Comments
 (0)