Skip to content

Commit 3c65c05

Browse files
prokoudinechennes
prokoudine
authored and
chennes
committed
Add the initial Ondsel Lens documentation
This is a direct port of https://ondsel.com/docs/ to Hugo, without any use of Hextra-specific markup or any kind of restructuring. Further work will include: - Documentation restructure and finalization - Documentation for on-prem Ondsel Lens deployment - Documentation for the Lens add-on
1 parent fe163f9 commit 3c65c05

File tree

132 files changed

+1303
-0
lines changed

Some content is hidden

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

132 files changed

+1303
-0
lines changed

‎.devcontainer/devcontainer.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"image": "mcr.microsoft.com/devcontainers/go:1",
3+
"features": {
4+
"ghcr.io/devcontainers/features/hugo:1": {
5+
"extended": true,
6+
"version": "0.132.2"
7+
},
8+
"ghcr.io/devcontainers/features/node:1": {}
9+
},
10+
"customizations": {
11+
"vscode": {
12+
"extensions": [
13+
"mhutchie.git-graph",
14+
"esbenp.prettier-vscode",
15+
"tamasfe.even-better-toml",
16+
"budparr.language-hugo-vscode"
17+
]
18+
}
19+
},
20+
"forwardPorts": [1313]
21+
}

‎.github/workflows/pages.yaml‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Sample workflow for building and deploying a Hugo site to GitHub Pages
2+
name: Deploy Hugo site to Pages
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: ["main"]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
# Default to bash
25+
defaults:
26+
run:
27+
shell: bash
28+
29+
jobs:
30+
# Build job
31+
build:
32+
runs-on: ubuntu-latest
33+
env:
34+
HUGO_VERSION: 0.132.2
35+
steps:
36+
- name: Checkout
37+
uses: actions/checkout@v4
38+
with:
39+
fetch-depth: 0 # fetch all history for .GitInfo and .Lastmod
40+
submodules: recursive
41+
- name: Setup Go
42+
uses: actions/setup-go@v5
43+
with:
44+
go-version: '1.22'
45+
- name: Setup Pages
46+
id: pages
47+
uses: actions/configure-pages@v4
48+
- name: Setup Hugo
49+
run: |
50+
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
51+
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
52+
- name: Build with Hugo
53+
env:
54+
# For maximum backward compatibility with Hugo modules
55+
HUGO_ENVIRONMENT: production
56+
HUGO_ENV: production
57+
run: |
58+
hugo \
59+
--gc --minify \
60+
--baseURL "${{ steps.pages.outputs.base_url }}/"
61+
- name: Upload artifact
62+
uses: actions/upload-pages-artifact@v3
63+
with:
64+
path: ./public
65+
66+
# Deployment job
67+
deploy:
68+
environment:
69+
name: github-pages
70+
url: ${{ steps.deployment.outputs.page_url }}
71+
runs-on: ubuntu-latest
72+
needs: build
73+
steps:
74+
- name: Deploy to GitHub Pages
75+
id: deployment
76+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Hugo output
2+
public/
3+
resources/
4+
.hugo_build.lock
5+
6+
# Editor
7+
.vscode/

‎.gitpod.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# This configuration file was automatically generated by Gitpod.
2+
# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
3+
# and commit this file to your remote git repository to share the goodness with others.
4+
5+
# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart
6+
7+
tasks:
8+
- name: Install Hugo
9+
before: brew install hugo
10+
init: echo "Your version of Hugo is `hugo version`" && hugo mod tidy
11+
command: hugo server -D -F --baseURL $(gp url 1313) --liveReloadPort=443 --appendPort=false --bind=0.0.0.0 --disableFastRender
12+
13+
ports:
14+
- port: 1313
15+
onOpen: open-preview

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Xin
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
# Lens Documentation
2+
3+
This is the documentation for Ondsel Lens, a free/libre product data management system designed for FreeCAD and FreeCAD-based software.
4+
5+
Currently, the documentation covers the use of the web interface only.

‎content/_index.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Ondsel Lens documentation
3+
toc: false
4+
---
5+
6+
{{< cards >}}
7+
{{< card link="docs" title="Docs" icon="book-open" >}}
8+
{{< card link="about" title="About" icon="user" >}}
9+
{{< /cards >}}
10+
11+

‎content/about.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: About
3+
type: about
4+
---
5+
6+
This is the documentation for Ondsel Lens, a free/libre product data
7+
management system designed for FreeCAD and FreeCAD-based software.

‎content/docs/_index.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: Welcome
3+
#next: first-page
4+
---
5+
6+
Ondsel Lens is an online vaulting and product data management service for mechanical engineers and industrial designers. Lens will help you collaborate and iterate on your product designs, as well as showcase and share your personal work.
7+
8+
![Ondsel Lens](ondsel-lens-public-1.png)
9+
10+
## Features
11+
12+
- Organize a team working on a product: create multiple workspaces per organization, invite and assign members
13+
- Manage the privacy of your designs
14+
- Create and manage revisions of your FCStd and STEP files
15+
- Comment on designs
16+
- Visualize FreeCAD documents with linked parts, such as assemblies
17+
- Customize parametric designs created with VarSets in FreeCAD
18+
- Create public and protected share links to your designs
19+
- Control whether people accessing your share link can download the design
20+
- Create and organize bookmarks for other people’s work
21+
22+
## Let's get started
23+
24+
- Upload a file
25+
- Explore it on Lens
26+
- Create a PIN-protected share link
27+
- Create a new workspace in your organization
28+
- Invite team members
29+
30+
## Project Background
31+
32+
Lens is built around FreeCAD, a free and open-source 3D CAD suite. It runs a containerized version of FreeCAD and uses some of the advanced features of the program.

‎content/docs/account-team/_index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
id: account-team
3+
title: Account & Team
4+
description: How to manage accounts, organizations, and teams
5+
weight: 4
6+
---
7+
8+
This section explain how to create new organizations, add team members, create and manage workspaces.
9+
10+
- [Account hierarchy](/docs/account-team/hierarchy/)
11+
- [Account settings](/docs/account-team/account-settings/)
12+
- [Managing organizations](/docs/account-team/organizations/)
13+
- [Managing workspaces](/docs/account-team/workspaces/)

0 commit comments

Comments
 (0)