{"id":28498464,"url":"https://github.com/pydio/docs","last_synced_at":"2026-04-24T12:32:52.234Z","repository":{"id":295845209,"uuid":"987607687","full_name":"pydio/docs","owner":"pydio","description":"Pydio Documentation formatted for MkDocs","archived":false,"fork":false,"pushed_at":"2026-02-11T17:00:36.000Z","size":256407,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-02-12T01:36:47.824Z","etag":null,"topics":["cells","docs","mkdocs","pydio"],"latest_commit_sha":null,"homepage":"https://pydio.com","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pydio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-21T10:19:28.000Z","updated_at":"2025-10-23T09:11:45.000Z","dependencies_parsed_at":"2026-02-11T19:02:57.533Z","dependency_job_id":null,"html_url":"https://github.com/pydio/docs","commit_stats":null,"previous_names":["pydio/docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pydio/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pydio%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pydio%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pydio%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pydio%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pydio","download_url":"https://codeload.github.com/pydio/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pydio%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32223979,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T10:26:35.452Z","status":"ssl_error","status_checked_at":"2026-04-24T10:25:27.643Z","response_time":64,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cells","docs","mkdocs","pydio"],"created_at":"2025-06-08T14:00:34.065Z","updated_at":"2026-04-24T12:32:52.229Z","avatar_url":"https://github.com/pydio.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pydio Docs Repository Structure\nThe Pydio documentation repository is organized into multiple branches and components for managing and building documentation.\n\n# Main Branch\nThe main branch contains the MkDocs configuration, tools, and utilities to convert and aggregate documents.\n\n## MkDocs Materials\n* overrides/\n* resources/\n* mkdocs.yml\n* requirements.txt\n* resources/versions.json: We use Mike to deploy multiple versions of the docs.\nMike generates versions.json automatically; however, we maintain resources/versions.json to manually control versions and their labels.\n\nThis file overrides the Mike-generated versions.json.\n\n## Document Conversion Tools\nLocated under the tools/ directory, these scripts handle the migration and aggregation of legacy documents from multiple repositories into a unified structure.\n\n### git_script.sh\n\n#### Prerequisites\nBefore running the script, clone the legacy repositories locally to:\n\n```\nLOCAL_REPO_ADMIN_GUIDE=\"/home/pydio/go/src/github.com/pydio/pydio-doc-admin-guide\"\nLOCAL_REPO_DEVELOPER_GUIDE=\"/home/pydio/go/src/github.com/pydio/pydio-doc-developer-guide\"\nLOCAL_REPO_KB=\"/home/pydio/go/src/github.com/pydio/pydio-doc-howto\"\n```\n\n#### Functionality\n`git_script.sh` scans these repositories across their respective branches and performs:\n\n* Adds .nav.yaml files to each folder, containing frontmatter (slug, title, etc.).\n* Inserts frontmatter metadata into each .md file:\n* title, slug, weight (used to order pages).\n* Fixes image links within .md files.\n* Replaces [:summary] placeholders with actual section TOCs.\n\n\n### local-build.sh\nThis script is used for local builds of the documentation using MkDocs and Mike.\n\n#### Mkdocs plugins build/setup\n\nSetup a clean python env\n\n```\npython -m venv /home/pydio/.venv\n```\n\nPropagate python Envs\n\n```\nsource /home/pydio/.venv/bin/activate\n```\n\npip install mkdocs mike\npip install mkdocs-material mkdocs-redirects mkdocs-minify-plugin pymdown-extensions mkdocs-glightbox\n\nInstall specific mkdocs plugin\n\n```\npip install git+https://github.com/pydio/mkdocs-awesome-nav\n```\n\n`pydio/mkdocs-awesome-nav` is an specific plugin enabling following features:\n- Understand the frontmatter of .md files such as title, slug, weight\n- Understand the .nav.yaml of each section for menu \u0026 navigation bar\n\nFor example:\n\n**Frontmatter:**\n\n```\n---\nslug: install-static-binaries\ntitle: Install Static Binaries\ndescription: Installing Pydio Cells on your server using our pre-compiled binaries.\nmenu: Static Binaries\nlanguage: und\nweight: 1\nmenu_name: menu-admin-guide-v7-enterprise\n\n---\nPage content\n\n```\n\n**.nav.yaml:**\n\n```\ntitle: Quick Start\nabstract: This section provides a full-spectrum overview of Pydio Cells installation, configuration and usage.\nmenu: Quick Start\nlanguage: und\nweight: 1\nmenu_name: menu-admin-guide-v7-enterprise\n\nslug: quick-start\n```\n\n## Document Branches\nThe actual documentation contents are stored in version-specific branches:\n\n* cells-v5\n\n* cells-v4 (latest)\n\n* pydio-v8\n\nEach branch contains its own GitHub workflow file:\n\n`.github/workflows/build-docs.yml` — triggers the documentation rebuild on push events.\n\n\n## Artifact Branch\n\n* gh-pages\n\nGitHub Actions use MkDocs and Mike to build the documentation and store the resulting artifacts in this branch.\n\nA separate GitHub Pages workflow listens to changes on gh-pages and triggers the website update process.\n\nLive Documentation: https://pydio.github.io/docs\n\n## Adding a new branch\n\nWhen you need a new branch:\n* Chekout new branch from one of document branches\n* Update [main branch] resources/versions.json file\n\n## Adding a new folder\n\nAt the top level, there are four repositories:\n- Admin Guide\n- CellsFlows\n- Developer Guide\n- Knowledge Base\n\nMKdocs uses these repositories for items in the top bar\n\nThe left menu in the page reflects the folder struct in each frist-level repository\n\nFor instance:\n\n```\nadmin-guide/\n├── 1_quick_start\n├── 2_running_cells_in_production\n├── 3_connecting_your_users\n├── 4_connecting_your_storage\n├── 5_securing_your_data\n├── 6_customize_interface\n├── 7_advanced\n├── images\n└── urlmaps\n```\n\n* **images** : repository for all images\n* **urlmaps**: A specific file containing the map of urls of legacy page to new format. Can be use for automatical redirection\n\nWhen you browse `Admin Guide` page, you will see in the left-menu\n\n```\n- Quick Start\n  ..\n- Run Cells in Production\n  ..\n```\n\n**FrontMatter** is a section in yaml instructs mkdocs to do following tasks:\n- formating url with slugs\n- labeling menu items by title\n- ordering menu items by weight\n\nFor a `.md` file, frontmatter are at the top of file\n\n\n```\n---\nslug: install-static-binaries\ntitle: Install Static Binaries\ndescription: Installing Pydio Cells on your server using our pre-compiled binaries.\nweight: 1\n---\nPage content\n```\n\nFor a repository, frontmatter is in `.nav.yaml` file at the top level of repository\n\n```\ntitle: Cells Installation\nabstract: Getting started with Pydio Cells using pre-compiled binaries or cloud images.\nweight: 1\nslug: cells-installation\n```\n\n\u003e Notice: only three meta are taken into account: `title`, `weight`, `slug`\n\n### Introduction page\nEach repository may have an introduction page. You can do by adding `index.md` file at the top level of the repository\n\nFor example:\n\n```\nThis section provides a full-spectrum overview of Cells installation, configuration and usage.\n\n- [Requirements](../requirements/)\n- [Quick Admin Tour](../quick-admin-tour/)\n- [Sharing Features](../sharing-features/)\n- [Connect Desktop Sync](../connect-desktop-sync/)\n- [Mobile Apps](../mobile-apps/)\n- [Glossary](../glossary/)\n\n```\n\n\u003e Notice: the menu item is clickable if an corresponding `index.md` exists\n\n\u003e WARNING: Don't add `slug` to frontmatter of an `index.md` file\n\n\u003e Notice: Adding a new topbar section, it's require addition copy line in .github/workflows/deploy-docs.yml file\n\n```\n      - name: Copy docs to docs repo\n        run: |\n          cp -r admin-guide docs\n          cp -r cellsflows docs\n          cp -r developer-guide docs\n          cp -r knowledge-base docs\n          \n          # New section\n          cp -r new-section docs\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpydio%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpydio%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpydio%2Fdocs/lists"}