Skip to content

Commit 74158cb

Browse files
committed
starting point for testing mass import from html
1 parent 535a8fe commit 74158cb

File tree

1,196 files changed

+24434
-5924
lines changed

Some content is hidden

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

1,196 files changed

+24434
-5924
lines changed

ADD_NEW_PRODUCT.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# Adding a New Product to Documentation
2+
3+
This guide explains how to add a new product to the Netwrix documentation site.
4+
5+
## Quick Steps
6+
7+
1. **Create the product documentation folder**
8+
```bash
9+
mkdir -p docs/YourProduct
10+
```
11+
12+
2. **Create the landing page** (`docs/YourProduct/index.md`)
13+
```markdown
14+
---
15+
id: index
16+
title: Your Product Documentation
17+
slug: /
18+
sidebar_label: Home
19+
---
20+
21+
# Your Product Documentation
22+
23+
Welcome to the Your Product documentation...
24+
```
25+
26+
3. **Create a sidebar configuration** (`sidebars/yourproduct.js`)
27+
```javascript
28+
const sidebars = {
29+
yourproductSidebar: [{type: 'autogenerated', dirName: '.'}],
30+
};
31+
export default sidebars;
32+
```
33+
34+
4. **Add the product to `docusaurus.config.js`**
35+
```javascript
36+
// In the plugins array, add:
37+
[
38+
'@docusaurus/plugin-content-docs',
39+
{
40+
id: 'yourproduct',
41+
path: 'docs/YourProduct',
42+
routeBasePath: 'docs/yourproduct',
43+
sidebarPath: './sidebars/yourproduct.js',
44+
editUrl: 'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
45+
versions: {
46+
current: {
47+
label: 'Current',
48+
},
49+
},
50+
},
51+
],
52+
```
53+
54+
5. **Add to navbar** (in `docusaurus.config.js` under `themeConfig.navbar.items`)
55+
- Add to Products dropdown:
56+
```javascript
57+
{
58+
label: 'Your Product',
59+
to: '/docs/yourproduct',
60+
},
61+
```
62+
- Add version dropdown:
63+
```javascript
64+
{
65+
type: 'docsVersionDropdown',
66+
position: 'right',
67+
docsPluginId: 'yourproduct',
68+
dropdownActiveClassDisabled: true,
69+
},
70+
```
71+
72+
6. **Update main documentation** (`docs/main/index.md`)
73+
- Add your product to the appropriate category with:
74+
```markdown
75+
- **[Your Product](/docs/yourproduct)** - Brief description
76+
```
77+
78+
7. **Update main sidebar** (`sidebars/main.js`)
79+
- Add to Product Documentation items:
80+
```javascript
81+
{
82+
type: 'link',
83+
label: 'Your Product',
84+
href: '/docs/yourproduct',
85+
},
86+
```
87+
88+
## Folder Structure Example
89+
90+
```
91+
docs/
92+
├── main/
93+
│ └── index.md
94+
├── YourProduct/
95+
│ ├── index.md
96+
│ ├── overview.md
97+
│ ├── Install/
98+
│ │ └── overview.md
99+
│ └── Admin/
100+
│ └── overview.md
101+
sidebars/
102+
├── main.js
103+
└── yourproduct.js
104+
```
105+
106+
## Notes
107+
108+
- Use lowercase for the route (`/docs/yourproduct`)
109+
- Use PascalCase for the folder name (`docs/YourProduct`)
110+
- The `id` in the plugin configuration should be lowercase
111+
- All products are now under `/docs/` instead of `/products/`

docs/1Secure/Admin/Alerts/Alerts.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

docs/1Secure/Admin/Alerts/Overview.md

Lines changed: 0 additions & 78 deletions
This file was deleted.

docs/1Secure/Admin/Dashboard/AlertsTimeline.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

0 commit comments

Comments
 (0)