Skip to content

Commit 3c7f50c

Browse files
committed
package/project prep/cleanup, prettier, config, readme, etc.
1 parent 42745c4 commit 3c7f50c

File tree

6,191 files changed

+31716
-50840
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

6,191 files changed

+31716
-50840
lines changed

.github/workflows/prettier.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Prettier Check
2+
3+
on:
4+
push:
5+
branches: ['*']
6+
pull_request:
7+
branches: ['*']
8+
9+
jobs:
10+
prettier:
11+
name: Run Prettier
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
18+
- name: Set up Node.js
19+
uses: actions/setup-node@v4
20+
with:
21+
node-version: '>=18.0'
22+
23+
- name: Install dependencies
24+
run: npm ci
25+
26+
- name: Run Prettier check
27+
run: npx prettier --check .

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ yarn-error.log*
2222
mdx-test-report.json
2323
pre-conversion-report.json
2424
post-conversion-report.json
25-
*.test-report.json
25+
*.test-report.json

.prettierignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Ignore artifacts:
2+
build
3+
coverage

.prettierrc

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"singleQuote": true,
3+
"semi": false,
4+
"trailingComma": "es5",
5+
"printWidth": 100,
6+
"tabWidth": 2,
7+
"overrides": [
8+
{
9+
"files": "*.md",
10+
"options": {
11+
"proseWrap": "always",
12+
"tabWidth": 4
13+
}
14+
},
15+
{
16+
"files": "*.ts",
17+
"options": {
18+
"semi": true
19+
}
20+
}
21+
]
22+
}

README.md

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,138 @@
11
# Netwrix Product Documentation
2+
3+
This repository contains the complete documentation site for all Netwrix products, built with [Docusaurus](https://docusaurus.io/). The site provides comprehensive user guides, configuration instructions, API documentation, and release notes for the entire Netwrix product suite.
4+
5+
## What's Included
6+
7+
This documentation covers the following Netwrix products:
8+
9+
### Security & Compliance
10+
- **1Secure** - Cloud security posture management
11+
- **Access Analyzer** - File access permissions and data governance
12+
- **Auditor** - IT infrastructure auditing and compliance
13+
- **Threat Manager/Prevention** - Security threat detection and response
14+
15+
### Identity & Access Management
16+
- **UserCube** (both on-premises and SaaS) - Identity governance and administration
17+
- **Password Policy Enforcer** - Active Directory password policy management
18+
- **Password Reset** - Self-service password reset solution
19+
- **Password Secure** - Privileged access management
20+
- **Privilege Secure** - Privileged account management
21+
22+
### Change Management & Governance
23+
- **StrongPoint for NetSuite** - Change management and compliance for NetSuite
24+
- **StrongPoint for Salesforce** - Change management for Salesforce environments
25+
- **StrongPoint NetSuite Flashlight** - NetSuite documentation and analysis
26+
- **StrongPoint Salesforce Flashlight** - Salesforce documentation and analysis
27+
28+
### IT Management
29+
- **Activity Monitor** - Real-time activity monitoring and alerting
30+
- **Change Tracker** - Infrastructure change tracking
31+
- **Data Classification** - Automated data discovery and classification
32+
- **Endpoint Protector** - Data loss prevention and device control
33+
- **Group ID** - Active Directory group management
34+
- **PolicyPak** - Group Policy management and enforcement
35+
- **Recovery for Active Directory** - AD backup and recovery
36+
37+
### Additional Tools
38+
- **Access Information Center** - Centralized access reporting
39+
- Various configuration guides and API documentation
40+
41+
## Prerequisites
42+
43+
- **Node.js**: Version 18.0 or higher
44+
- **npm**: Comes with Node.js
45+
46+
## Quick Start
47+
48+
1. **Install dependencies:**
49+
```bash
50+
npm install
51+
```
52+
53+
2. **Start development server:**
54+
```bash
55+
npm start
56+
```
57+
This starts a local development server and opens the site in your browser. Most changes are reflected live without requiring a restart.
58+
59+
3. **Build for production:**
60+
```bash
61+
npm run build
62+
```
63+
This generates static content into the `build` directory that can be served by any static hosting service.
64+
65+
## Available Scripts
66+
67+
- `npm start` - Start local development server
68+
- `npm run build` - Build the site for production
69+
- `npm run serve` - Serve the production build locally
70+
- `npm run clear` - Clear Docusaurus cache
71+
- `npm run typecheck` - Run TypeScript type checking
72+
- `npm run swizzle` - Eject and customize Docusaurus components
73+
74+
## Project Structure
75+
76+
```
77+
docs/
78+
├── docs/ # Documentation content
79+
│ ├── 1secure/ # 1Secure product docs
80+
│ ├── usercube/ # UserCube on-premises docs
81+
│ ├── usercube_saas/ # UserCube SaaS docs
82+
│ ├── strongpoint*/ # StrongPoint product variants
83+
│ └── [other-products]/ # Other product documentation
84+
├── static/ # Static assets (images, files)
85+
├── src/ # Custom React components and CSS
86+
├── sidebars/ # Navigation configuration per product
87+
├── versioned_docs/ # Versioned documentation
88+
├── docusaurus.config.js # Main Docusaurus configuration
89+
└── package.json # Dependencies and scripts
90+
```
91+
92+
## Deployment
93+
94+
This project uses automatic deployment via Render:
95+
96+
- **Production**: Automatically deploys when changes are pushed to the `main` branch
97+
- **Development**: Automatically deploys when changes are pushed to the `dev` branch
98+
99+
The deployment process runs `npm run build` and serves the generated static files.
100+
101+
## Writing Documentation
102+
103+
- Documentation is written in **Markdown** with optional **MDX** support for React components
104+
- Each product has its own folder under `docs/`
105+
- Navigation is configured in the corresponding sidebar file in `sidebars/`
106+
- Images and downloadable files go in the `static/` directory
107+
- Use relative links between documentation pages
108+
109+
## Configuration
110+
111+
- **Main config**: `docusaurus.config.js`
112+
- **Product-specific builds**: `docusaurus.config.products.js`
113+
- **Sidebars**: Individual files in `sidebars/` directory
114+
- **Styling**: Custom CSS in `src/css/custom.css`
115+
116+
## Technical Details
117+
118+
- **Framework**: Docusaurus 3.8.1
119+
- **React**: 18.3.1
120+
- **Build tool**: Built-in Docusaurus build system
121+
- **Memory allocation**: Increased to 8GB for large documentation builds
122+
- **Browser support**: Modern browsers (see `browserslist` in package.json)
123+
124+
## Contributing
125+
126+
1. Make changes to the appropriate documentation files
127+
2. Test locally with `npm start`
128+
3. Ensure the build succeeds with `npm run build`
129+
4. Commit and push to the appropriate branch (`dev` for testing, `main` for production)
130+
131+
## Support
132+
133+
For technical issues with the documentation site, please check:
134+
1. The Docusaurus documentation: https://docusaurus.io/docs
135+
2. Build logs in the deployment system
136+
3. Browser console for client-side issues
137+
138+
For product-specific documentation questions, refer to the respective product documentation or contact the product teams.

docs/1secure/admin/alerts/alerts.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ When you create an alert profile, several alerts are preconfigured for it. You c
44

55
You can access the generated alerts in the following ways:
66

7-
- View the alerts generated for an organization on the Netwrix 1Secure dashboard. See the [1Secure Dashboard](/docs/1secure/admin/dashboard/overview.md) topic for additional information.
8-
- Receive alerts as email notifications sent to the specified email address(es). See the [Manage Delivery Settings for an Alert Profile ](/docs/1secure/admin/alerts/overview.md#manage-delivery-settings-for-an-alert-profile)topic for setting up email notifications.
7+
- View the alerts generated for an organization on the Netwrix 1Secure dashboard. See the [1Secure Dashboard](../dashboard/overview.md) topic for additional information.
8+
- Receive alerts as email notifications sent to the specified email address(es). See the [Manage Delivery Settings for an Alert Profile ](overview.md#manage-delivery-settings-for-an-alert-profile)topic for setting up email notifications.
99

1010
Follow the steps to view the alerts within an alert profile.
1111

1212
__Step 1 –__ Navigate to Configuration > Alerts.
1313

1414
__Step 2 –__ Click an alert profile. The alerts for the profile are displayed in a list.
1515

16-
![Alerts List within an alert profile](/img/product_docs/1secure/admin/alerts/alertslist.webp)
16+
![Alerts List within an alert profile](../../../../static/img/product_docs/1secure/admin/alerts/alertslist.webp)
1717

1818
You can view the following for each alert in the list:
1919

@@ -35,9 +35,9 @@ __Step 2 –__ Click an alert profile. The alerts for the profile are displayed
3535

3636
__Step 3 –__ Click __Add__. The New Alert pane is displayed.
3737

38-
![New Alert Pane](/img/product_docs/1secure/admin/alerts/addcustomalert.webp)
38+
![New Alert Pane](../../../../static/img/product_docs/1secure/admin/alerts/addcustomalert.webp)
3939

40-
__Step 4 –__ Select a custom report from the Report drop-down menu to trigger the alert when a new record is generated for the report. See the [ Custom Reports](/docs/1secure/admin/searchandreports/customreports.md) topic for additional information.
40+
__Step 4 –__ Select a custom report from the Report drop-down menu to trigger the alert when a new record is generated for the report. See the [ Custom Reports](../searchandreports/customreports.md) topic for additional information.
4141

4242
__Step 5 –__ Specify a name and description for the alert.
4343

docs/1secure/admin/alerts/overview.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Alert profiles provide a way to easily group alert configurations and delivery n
44

55
To view the alert profiles, navigate to Configuration > Alerts.
66

7-
![Alert Profiles List](/img/product_docs/1secure/admin/alerts/alertsprofiles.webp)
7+
![Alert Profiles List](../../../../static/img/product_docs/1secure/admin/alerts/alertsprofiles.webp)
88

99
Alert profiles are displayed in the list with the following information:
1010

@@ -23,14 +23,14 @@ __Step 1 –__ Navigate to Configuration > Alerts.
2323

2424
__Step 2 –__ Click __Add profile__. The New alert profile pane is displayed.
2525

26-
![New Alert Profile pane](/img/product_docs/1secure/admin/alerts/addalertprofile.webp)
26+
![New Alert Profile pane](../../../../static/img/product_docs/1secure/admin/alerts/addalertprofile.webp)
2727

2828
__Step 3 –__ Enter a name for the alert profile in the Name field and click __Save__.
2929

3030
The alert profile is added to the list. You can:
3131

32-
- Assign this profile to an organization. You can do this when creating a new organization or editing an organization. See the [Add Organizations](/docs/1secure/admin/organizations/addorganizations.md) topic for additional information.
33-
- Click the profile to review the list of alerts, enable the desired alerts, make necessary edits for alerts, and set delivery settings for the alert profile. See the [Alerts](/docs/1secure/admin/alerts/alerts.md) topic for additional information.
32+
- Assign this profile to an organization. You can do this when creating a new organization or editing an organization. See the [Add Organizations](../organizations/addorganizations.md) topic for additional information.
33+
- Click the profile to review the list of alerts, enable the desired alerts, make necessary edits for alerts, and set delivery settings for the alert profile. See the [Alerts](alerts.md) topic for additional information.
3434

3535
## Modify the Name of an Alert Profile
3636

@@ -69,7 +69,7 @@ __Step 2 –__ Click an alert profile. The alerts for the profile are displayed
6969

7070
__Step 3 –__ Click the Email icon under Delivery Settings. The Email Delivery Settings pane is displayed.
7171

72-
![Email Delivery Settings pane](/img/product_docs/1secure/admin/alerts/alertsemaildelivery.webp)
72+
![Email Delivery Settings pane](../../../../static/img/product_docs/1secure/admin/alerts/alertsemaildelivery.webp)
7373

7474
__Step 4 –__ . Toggle the Enabled switch to ON to enable email notifications for the alert profile.
7575

@@ -79,4 +79,4 @@ __Step 6 –__ Check the __Email Organization Admins__ check box to send the ale
7979

8080
__Step 7 –__ Click Save.
8181

82-
You may also link to a third-party ticketing system. See the [Third-party systems](/docs/1secure/integration/overview.md) topic for additional information.
82+
You may also link to a third-party ticketing system. See the [Third-party systems](../../integration/overview.md) topic for additional information.

docs/1secure/admin/dashboard/alertstimeline.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To access the Alerts Timeline page, click __Home__ at the top and do one of the
88
- On the Top 5 Triggered Alerts by Type chart, click a bar. It opens the Alerts Timeline page that displays alert-related data for all managed organizations.
99
- In the organizations list, click an organization name to navigate to the Organization Statistics page, then click the Alerts Timeline chart. It opens the Alerts Timeline page that displays alert-related data for the organization selected in the organizations list.
1010

11-
![Alerts Timeline Page](/img/product_docs/1secure/admin/dashboard/alertstimeline.webp)
11+
![Alerts Timeline Page](../../../../static/img/product_docs/1secure/admin/dashboard/alertstimeline.webp)
1212

1313
If you are a managed organization user, this page displays insights specific to your organization.
1414

@@ -39,13 +39,13 @@ This section lists all the triggered alerts with the following information:
3939
- Num activity records – Displays the number of activity records associated with the triggered alert, based on the threshold value set for it. The threshold is the minimum number of activity records that must occur within a specified time frame (threshold period) to trigger an alert.
4040
- Last updated – Displays the date and time when the alert is triggered, based on the threshold value set for it. The threshold is the minimum number of activity records that must occur within a specified time frame (threshold period) to trigger an alert.last updated.
4141
- Item – Displays the name of the entity by which the alert is grouped, such as a computer, file, user, etc.
42-
- Activity Records – Click the Activity Records link for an alert to navigate to the Activity page, where you can view a detailed report for that alert type. See the [Activity Reports](/docs/1secure/admin/searchandreports/activity.md) topic for additional information.
42+
- Activity Records – Click the Activity Records link for an alert to navigate to the Activity page, where you can view a detailed report for that alert type. See the [Activity Reports](../searchandreports/activity.md) topic for additional information.
4343

4444
Click a column header to sort data in the alerts list by that column in ascending order. An arrow appears next to the column name to indicate the sort order. Click the column header again to sort the data in descending order.
4545

4646
Edit Alerts Settings
4747

48-
Click the __Edit Alerts Settings__ link to navigate to the Alerts page, where you can create a new alert and modify existing ones. See the [Alerts](/docs/1secure/admin/alerts/alerts.md) topic for additional information.
48+
Click the __Edit Alerts Settings__ link to navigate to the Alerts page, where you can create a new alert and modify existing ones. See the [Alerts](../alerts/alerts.md) topic for additional information.
4949

5050
## Filter Data
5151

0 commit comments

Comments
 (0)