Skip to content

Commit 004f057

Browse files
committed
fixing categories, adding contribution guide, and removing html blockquote
1 parent f076d9f commit 004f057

35 files changed

Lines changed: 107 additions & 98 deletions
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: netapp-connector
3-
version: 25.12.2
3+
version: 26.1.1
44
description: NetApp Neo v3.x for Microsoft 365 Copilot Connector Helm Chart
5-
appVersion: "3.1.0"
5+
appVersion: "3.2.0"
66
type: application

docs/.vitepress/config.mts

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ export default defineConfig({
2828
{ text: 'Content Posts', link: '/content/posts' },
2929
{ text: 'Projects', link: '/projects', },
3030
{ text: 'Legal Notice', link: '/projects/legal-notices' },
31+
{ text: 'Doc Contribution Guide', link: '/CONTRIBUTING' },
3132
{
3233
text: 'Cloud',
3334
items: [
@@ -49,51 +50,51 @@ export default defineConfig({
4950
text: 'ML/AI',
5051
items: [
5152
{
52-
text: 'Neo', link: '/projects/neo/core/overview',
53+
text: 'Neo', link: '/projects/mlai/neo/core/overview',
5354
collapsed: true,
5455
items: [
55-
{ text: 'Introduction', link: '/projects/neo/core/introduction' },
56-
{ text: 'Release Notes', link: '/projects/neo/core/release-notes',
56+
{ text: 'Introduction', link: '/projects/mlai/neo/core/introduction' },
57+
{ text: 'Release Notes', link: '/projects/mlai/neo/core/release-notes',
5758
items: [
58-
{ text: 'Core', link: '/projects/neo/core/rn-core' },
59-
{ text: 'Console', link: '/projects/neo/core/rn-console' },
59+
{ text: 'Core', link: '/projects/mlai/neo/core/rn-core' },
60+
{ text: 'Console', link: '/projects/mlai/neo/core/rn-console' },
6061
],
6162
},
62-
{ text: 'Prerequisites', link: '/projects/neo/core/prerequisites' },
63-
{ text: 'Quick Start', link: '/projects/neo/core/quick-start',
63+
{ text: 'Prerequisites', link: '/projects/mlai/neo/core/prerequisites' },
64+
{ text: 'Quick Start', link: '/projects/mlai/neo/core/quick-start',
6465
items: [
65-
{ text: 'Docker/Podman', link: '/projects/neo/core/qs-docker' },
66-
{ text: 'Kubernetes', link: '/projects/neo/core/qs-kubernetes' },
66+
{ text: 'Docker/Podman', link: '/projects/mlai/neo/core/qs-docker' },
67+
{ text: 'Kubernetes', link: '/projects/mlai/neo/core/qs-kubernetes' },
6768
],
6869
},
69-
{ text: 'Deployment', link: '/projects/neo/core/deployment',
70+
{ text: 'Deployment', link: '/projects/mlai/neo/core/deployment',
7071
items: [
71-
{ text: 'Configuration', link: '/projects/neo/core/d-configuration' },
72-
{ text: 'Sizing', link: '/projects/neo/core/d-sizing' },
73-
{ text: 'Upgrades', link: '/projects/neo/core/d-upgrades' },
72+
{ text: 'Configuration', link: '/projects/mlai/neo/core/d-configuration' },
73+
{ text: 'Sizing', link: '/projects/mlai/neo/core/d-sizing' },
74+
{ text: 'Upgrades', link: '/projects/mlai/neo/core/d-upgrades' },
7475
],
7576
},
76-
{ text: 'Management', link: '/projects/neo/core/management',
77+
{ text: 'Management', link: '/projects/mlai/neo/core/management',
7778
items: [
78-
{ text: 'Neo Console', link: '/projects/neo/core/m-console' },
79-
{ text: 'Microsoft 365 Copilot', link: '/projects/neo/core/m-m365-copilot.md' },
80-
{ text: 'API', link: '/projects/neo/core/m-api' },
81-
{ text: 'MCP', link: '/projects/neo/core/m-mcp' },
82-
{ text: 'Users', link: '/projects/neo/core/m-users' },
83-
{ text: 'Shares', link: '/projects/neo/core/m-shares' },
84-
{ text: 'Files', link: '/projects/neo/core/m-files' },
85-
{ text: 'Rules & Filters', link: '/projects/neo/core/m-rules-filters' },
86-
{ text: 'Items Level Permissions', link: '/projects/neo/core/m-acls' },
87-
{ text: 'Shares', link: '/projects/neo/core/m-shares' },
79+
{ text: 'Neo Console', link: '/projects/mlai/neo/core/m-console' },
80+
{ text: 'Microsoft 365 Copilot', link: '/projects/mlai/neo/core/m-m365-copilot.md' },
81+
{ text: 'API', link: '/projects/mlai/neo/core/m-api' },
82+
{ text: 'MCP', link: '/projects/mlai/neo/core/m-mcp' },
83+
{ text: 'Users', link: '/projects/mlai/neo/core/m-users' },
84+
{ text: 'Shares', link: '/projects/mlai/neo/core/m-shares' },
85+
{ text: 'Files', link: '/projects/mlai/neo/core/m-files' },
86+
{ text: 'Rules & Filters', link: '/projects/mlai/neo/core/m-rules-filters' },
87+
{ text: 'Items Level Permissions', link: '/projects/mlai/neo/core/m-acls' },
88+
{ text: 'Shares', link: '/projects/mlai/neo/core/m-shares' },
8889
],
8990
},
90-
{ text: 'Security', link: '/projects/neo/core/security' },
91-
{ text: 'Troubleshooting', link: '/projects/neo/core/troubleshooting'},
92-
{ text: 'Notice', link: '/projects/neo/core/NOTICE.md' },
91+
{ text: 'Security', link: '/projects/mlai/neo/core/security' },
92+
{ text: 'Troubleshooting', link: '/projects/mlai/neo/core/troubleshooting'},
93+
{ text: 'Notice', link: '/projects/mlai/neo/core/NOTICE.md' },
9394
],
9495
},
95-
{ text: 'Neo UI Framework', link: '/projects/neo/uif/ui-framework' },
96-
{ text: 'Neo Fuse Client', link: '/projects/neo/nfc/fuse-client' },
96+
{ text: 'Neo UI Framework', link: '/projects/mlai/neo/uif/ui-framework' },
97+
{ text: 'Neo Fuse Client', link: '/projects/mlai/neo/nfc/fuse-client' },
9798
]
9899
},
99100
],

docs/CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to Documentation
2+
3+
Thank you for your interest in improving our documentation! This site is built with [VitePress](https://vitepress.dev/) and covers the NetApp Innovations Labs projects.
4+
5+
## Project Structure
6+
7+
* **```docs/```**: The source code for the documentation site.
8+
* **```docs/content/```**: Portfolio of our team's contribution to blogs, videos, etc.
9+
* **```docs/projects/[cloud,containers,mlai]```**: Documentation per domain
10+
* **`docs/.vitepress/`**: Site configuration, theme, and sidebar settings.
11+
12+
## Local Development
13+
14+
To update and preview documentation changes locally before pushing:
15+
16+
1. **Prerequisites**
17+
* [Node.js](https://nodejs.org/en/download) (version 20 or higher)
18+
* npm (comes with Node.js)
19+
* Fork the [NetApp Innovation Labs](https://github.com/NetApp/Innovation-Labs) repository
20+
21+
2. **Setup**
22+
```bash
23+
# Install dependencies
24+
npm install
25+
```
26+
27+
3. **Run the Dev Server**
28+
```bash
29+
npm run docs:dev
30+
```
31+
The site will start at ```http://localhost:5173```. Any changes you make to markdown files will hot-reload automatically.
32+
33+
## Writing Guidelines
34+
35+
We use native and GitHub Markdown without any HTML or add-ons with VitePress extensions and follow the categories/subcategories of the existing content.
36+
37+
### Adding a New Page
38+
1. Create a ```.md``` file in the appropriate directory (e.g., ```docs/projects/cloud/my-new-project.md```).
39+
2. Add the file to the **sidebar** (not the **nav**) in ```docs/.vitepress/config.mts``` so it appears in the sidebar navigation menu.
40+
41+
### images
42+
Place images in the ```docs/public``` folder and reference with the markdown tag
43+
```![Description of image](/my-image.png)```
44+
45+
## Publishing
46+
Once you are happy with your content, open a Pull Request from your repository towards ours and we will review your contributions!
File renamed without changes.

docs/projects/neo/core/d-configuration.md renamed to docs/projects/mlai/neo/core/d-configuration.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ This guide assumes you have already reviewed the [Prerequisites](../prerequisite
44

55
When the connector is deployed it will deploy in SETUP mode by default. This allows you to complete the initial configuration of the connector via the API or web console. Once the connector is configured it can be switched to PRODUCTION mode.
66

7-
<blockquote style="background-color: #e7f3ff; border-left: 4px solid #2196F3; padding: 10px; margin: 10px 0;">
8-
<strong>📘 Note:</strong> The following guidance is temporary and will be native in Neo Console in a future release. During this time please follow the steps below to switch between modes and configure your license.
9-
</blockquote>
7+
> [!NOTE]
8+
> The following guidance is temporary and will be native in Neo Console in a future release. During this time please follow the steps below to switch between modes and configure your license.
109
1110
## How to check which mode the connector is in
1211

File renamed without changes.
Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,10 @@ PATCH /shares/{share_id}
151151
}
152152
```
153153

154-
<blockquote style="background-color: #e7f3ff; border-left: 4px solid #2196F3; padding: 10px; margin: 10px 0;">
155-
<strong>📘 Note:</strong> After changing ACL settings, you may want to trigger a re-crawl to update permissions on existing files:
156-
<pre><code>POST /shares/{share_id}/crawl
157-
</code></pre>
158-
</blockquote>
154+
> [!NOTE]
155+
> After changing ACL settings, you may want to trigger a re-crawl to update permissions on existing files:
156+
> ```POST /shares/{share_id}/crawl```
157+
159158

160159
## Combining with Other Rules
161160

@@ -211,15 +210,11 @@ Check application logs for ACL override activity:
211210

212211
## Security Considerations
213212

214-
<blockquote style="background-color: #ffe6e6; border-left: 4px solid #f44336; padding: 10px; margin: 10px 0;">
215-
<strong>❗ Important:</strong> ACL overrides bypass the original file permissions. Consider the following:
216-
<ol>
217-
<li><strong>Data Exposure Risk</strong>: Using <code>acl_override_mode: "everyone"</code> makes all files in the share accessible to everyone in your Entra tenant. Only use this for truly public content.</li>
218-
<li><strong>Audit Trail</strong>: The original file ACLs are still extracted and stored in the database for auditing purposes, even when overrides are applied.</li>
219-
<li><strong>Principle of Least Privilege</strong>: When using <code>specified</code> mode, grant access only to the users and groups that genuinely need it.</li>
220-
<li><strong>Regular Review</strong>: Periodically review shares with ACL overrides to ensure the permissions are still appropriate.</li>
221-
</ol>
222-
</blockquote>
213+
> [!WARNING]
214+
> - **Data Exposure Risk**: Using ```acl_override_mode: "everyone"``` makes all files in the share accessible to everyone in your Entra tenant. Only use this for truly public content.
215+
> - **Audit Trail**: The original file ACLs are still extracted and stored in the database for auditing purposes, even when overrides are applied.
216+
> - **Principle of Least Privilege**: When using ```specified``` mode, grant access only to the users and groups that genuinely need it.
217+
> - **Regular Review**: Periodically review shares with ACL overrides to ensure the permissions are still appropriate.
223218
224219
## Comparison: ACL Override vs ACL_STRICT_MODE
225220

0 commit comments

Comments
 (0)