Skip to content

Commit 94c6519

Browse files
committed
minor updates, some front matter
1 parent 3ae2ad8 commit 94c6519

File tree

178 files changed

+1087
-159
lines changed

Some content is hidden

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

178 files changed

+1087
-159
lines changed

README.md

Lines changed: 24 additions & 124 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,11 @@ cd docs
3636
npm install
3737

3838
# Start development server (all products)
39-
npm start
39+
npm run start
4040

4141
# Single product mode (recommended for development)
42-
npm start 1secure
43-
npm start accessanalyzer/12.0
42+
npm run start 1secure
43+
npm run start accessanalyzer/12.0
4444
```
4545

4646
## 📁 Project Structure
@@ -110,7 +110,7 @@ npm run serve # Serve production build after `npm run build`
110110

111111
The new centralized system makes development much simpler:
112112

113-
1. **Start development server**: `npm start`
113+
1. **Start development server**: `npm run start`
114114
2. **Make changes** to documentation or configuration
115115
3. **Hot reload** automatically updates the site
116116
4. **All products and versions** work seamlessly
@@ -121,9 +121,9 @@ For backward compatibility, single-product scripts still work:
121121

122122
```bash
123123
# Examples (optional - full site starts quickly now)
124-
npm start 1secure
125-
npm start accessanalyzer/12.0
126-
npm start identitymanager/saas
124+
npm run start 1secure
125+
npm run start accessanalyzer/12.0
126+
npm run start identitymanager/saas
127127
```
128128

129129
## ⚙️ Centralized Configuration System
@@ -343,7 +343,7 @@ description: 'SEO description'
343343
- **Paths**: Always absolute from project root
344344

345345
```markdown
346-
![Description](/img/product_docs/productname/feature.webp)
346+
![Description](/img/product_docs/productname/image.webp)
347347
```
348348

349349
## 🚀 Deployment
@@ -353,161 +353,61 @@ description: 'SEO description'
353353
- **Production**: Auto-deploys from `main` branch
354354
- **Development**: Auto-deploys from `dev` branch
355355

356-
### Environment Configuration
357-
358-
- **URL**: Uses `RENDER_EXTERNAL_URL` environment variable
359-
- **Memory**: 8GB limit for large builds
360-
- **Analytics**: Google Analytics with tracking ID `G-FZPWSDMTEX`
361-
- **Search**: Algolia search with app ID `KPMSCF6G6J`
362-
363356
## 🤝 Contributing
364357

365358
### Simplified Development Workflow
366359

367-
Thanks to the centralized configuration system, contributing is now much easier:
360+
Contributing is easy:
368361

369362
1. **Start development server**:
370363

371364
```bash
372-
npm start
365+
npm run start
373366
```
374367

375368
2. **Make changes** to documentation or configuration
376369

377370
3. **Format code** before committing:
378371

372+
If this isn't done, a pre-commit hook will do it for you anyways.
373+
379374
```bash
380375
npm run format
381376
```
382377

383-
4. **Test build**:
378+
4. **Test builds**:
379+
380+
Test a build of the docs you edited:
384381

385382
```bash
386-
npm run build
383+
npm run build [product][/version]
387384
```
388385

389-
5. **Submit pull request**
390-
391-
### Adding New Products (3-Step Process)
392-
393-
1. **Add product to `src/config/products.js`**
394-
2. **Create documentation folder and files**
395-
3. **Create sidebar configuration**
396-
397-
That's it! No more editing multiple files or complex configurations.
398-
399-
### Code Style Guidelines
400-
401-
- **Format with Prettier**: `npm run format`
402-
- **TypeScript validation**: `npm run typecheck`
403-
- **Follow existing naming conventions**
404-
- **Add JSDoc comments for complex functions**
405-
- **Keep components focused and reusable**
406-
407-
## 🔍 Testing & Quality Assurance
408-
409-
### Pre-Deployment Checklist
410-
411-
Before submitting changes:
386+
Test a build of all docs:
412387

413388
```bash
414-
# 1. Code formatting
415-
npm run format:check
389+
npm run build
390+
```
416391

417-
# 2. TypeScript validation
418-
npm run typecheck
392+
5. **Submit pull request**
419393

420-
# 3. Build validation
421-
npm run build
394+
Create a PR to the dev branch, and then main when ready for production.
422395

423-
# 4. Manual testing
424-
npm start
425-
# Test navigation, search, and product pages
426-
```
396+
## 🔍 Testing & Quality Assurance
427397

428398
### Common Testing Scenarios
429399

430400
-**Homepage loads** with all product categories
431401
-**Product pages accessible** from homepage links
432402
-**Version badges work** for multi-version products
433-
-**Search functionality** finds relevant content
434-
-**Mobile responsive** design works
435-
-**Dark mode toggle** functions properly
436-
437-
## 🛠️ Troubleshooting
438-
439-
### Build Issues
440-
441-
```bash
442-
# Clear cache and rebuild
443-
npm run clear
444-
npm run build
445-
446-
# Check for configuration errors
447-
npm run typecheck
448-
```
449-
450-
### Common Problems
451-
452-
**"Cannot find module" errors**
453-
454-
- Verify sidebar file paths in `src/config/products.js`
455-
- Check that referenced sidebar files exist
456-
457-
**Products missing from homepage**
458-
459-
- Ensure product category matches exactly with `PRODUCT_CATEGORIES`
460-
- Verify `generateProductCategories()` import
461-
462-
**Routing problems**
463-
464-
- Check `path` and version configurations in `products.js`
465-
- Look for conflicting route definitions
466-
467-
### Performance Issues
468-
469-
- Use `npm run clear` to clear cache
470-
- Restart development server for configuration changes
471-
- Check browser developer tools for specific errors
472-
473-
## 🔄 Migration Guide
474-
475-
### From Old Architecture
476-
477-
If you're familiar with the previous setup:
478-
479-
- **Product configs** moved from `docusaurus.config.js``src/config/products.js`
480-
- **Homepage products** moved from `HomepageFeatures/index.js``src/config/products.js`
481-
- **Meta tag mappings** moved from `ProductMetaTags/index.js``src/config/products.js`
482-
483-
### Benefits of New System
484-
485-
-**80% fewer lines** of configuration code
486-
-**Single source of truth** for all product data
487-
-**Automatic consistency** across components
488-
-**Faster development** and easier maintenance
489-
-**Nearly impossible** to create configuration errors
490403

491404
## 📚 Resources
492405

493406
- **Docusaurus Documentation**: [docusaurus.io](https://docusaurus.io/)
494407
- **MDX Guide**: [mdxjs.com](https://mdxjs.com/)
495408
- **React Documentation**: [react.dev](https://react.dev/)
496-
- **Netwrix Products**: [netwrix.com](https://www.netwrix.com/)
497-
498-
## 📞 Support & Community
499-
500-
- **Documentation Issues**: Create an issue in this repository
501-
- **Product Support**: [Netwrix Support Portal](https://www.netwrix.com/support.html)
502-
- **Community**: [Netwrix Community](https://community.netwrix.com)
503-
- **GitHub**: [github.com/netwrix](https://github.com/netwrix)
409+
- **Algolia Documentation**: [algolia.com](https://www.algolia.com/doc/)
504410

505411
## 📄 License
506412

507-
This documentation site is maintained by Netwrix Corporation.
508-
509-
For licensing information and product inquiries, visit [netwrix.com](https://www.netwrix.com/).
510-
511-
---
512-
513-
**Built with ❤️ using [Docusaurus](https://docusaurus.io/) and powered by the revolutionary centralized configuration system.**
413+
This documentation site is MIT licensed and open source, and is maintained by Netwrix Corporation.

docs/1secure/administration/credentials/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Credential Management
3+
sidebar_label: Credentials
4+
description: Manage credentials for data sources in 1Secure. Review, edit, and delete credentials for cloud and on-premises source connections.
5+
---
6+
17
# Manage Credentials
28

39
In Netwrix 1Secure, you need to set up credentials while adding the sources for crawling your data.

docs/1secure/administration/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Administration and Management
3+
sidebar_label: Administration
4+
description: Administrative tools for managing organizations, users, credentials, and configuration settings in 1Secure security platform.
5+
---
6+
17
# Admin
28

39
```mdx-code-block

docs/1secure/administration/organizations/dashboard-customization.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Organization Dashboard and Tabs
3+
sidebar_label: Dashboard Customization
4+
description: View and navigate organization tabs including sources, sites, credentials, users, and subscriptions. Access organization dashboards.
5+
---
6+
17
# View Tabs and Dashboards for the Organization
28

39
After adding an organization, you can view available tabs for the organization on the **Managed organizations** page.

docs/1secure/administration/organizations/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Organization Management Overview
3+
sidebar_label: Organizations
4+
description: Overview of organization management in 1Secure, including parent and child tenants, MSP configurations, and organizational structure setup.
5+
---
6+
17
# Manage Organizations
28

39
Netwrix 1Secure operates as a service, providing data analysis and reporting capabilities for the

docs/1secure/administration/organizations/managing-organizations.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Adding and Managing Organizations
3+
sidebar_label: Managing Organizations
4+
description: Step-by-step guide to add organizations in 1Secure, configure data sources, and manage organization settings for MSP environments.
5+
---
6+
17
# Add Organizations
28

39
Follow the steps to add an organization.
@@ -71,16 +77,7 @@ organization.
7177

7278
## The organization is now added.
7379

74-
id: manage-my-organization
75-
title: "Manage My Organization"
76-
pagination_label: "Manage My Organization"
77-
sidebar_label: "Manage My Organization"
78-
sidebar_position: 35
79-
description: "Learn how to review and edit your organization profile settings and manage deletion requests."
80-
81-
---
82-
83-
# Manage My Organization
80+
## Manage My Organization
8481

8582
After you added your organization, you can review or edit your profile on Configuration > My
8683
Organization page.

docs/1secure/administration/organizations/organization-groups.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Organization Groups for Access Control
3+
sidebar_label: Organization Groups
4+
description: Create and manage organization groups to control user access to specific organizations, enabling role-based management in MSP environments.
5+
---
6+
17
# Organization Groups
28

39
An organization group allows designated users to access and manage only the specific organizations

docs/1secure/administration/organizations/sites.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Organization Sites Management
3+
sidebar_label: Sites
4+
description: Add and manage sites within organizations to represent physical locations and track on-premises agent status for MSP clients.
5+
---
6+
17
# Add Sites to an Organization
28

39
Sites are used to signify physical groupings within the organization. The feature is helpful for

docs/1secure/administration/user-management/adding-users.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Adding Users to Organizations
3+
sidebar_label: Adding Users
4+
description: Add and manage users in 1Secure organizations with role-based access including Administrator, Editor, and Viewer permissions.
5+
---
6+
17
# Add Users
28

39
After you added the organization to your system, you may want to add users as part of your

docs/1secure/administration/user-management/billable-accounts.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Billable Accounts Overview
3+
sidebar_label: Billable Accounts
4+
description: Understanding billable account calculations for Active Directory and Microsoft Entra ID users, including deduplication and reporting features.
5+
---
6+
17
# Billable Accounts
28

39
Netwrix 1Secure provides an information on the billable accounts – the enabled Active

0 commit comments

Comments
 (0)