[WIP] New Developer Documentation Infrastructure: Tasks, Questions, Plan of Action #105349

Closed
opened 2023-03-01 18:59:15 +01:00 by Julian Eisel · 2 comments
Member

General questions

  • A Git LFS repository?
  • Always pull the repository with Blender sources using make update (like add-ons)?
  • (Material for) MkDocs doesn't support a Gitea integration natively (only GitHub, GitLab or Bitbucket). This is used for example to display an "Edit" button linking to the source markdown file in the repository. Can we get that done somehow?
  • Do we also put developer documentation for other blender.org projects here? Flamenco, websites, infrastructure, ...

Adding versioning or translations for the technical documentation probably isn't worth it. However people can build an earlier version from the git repository.

What needs to be done

Scalable Navigation Design

The navigation generated by (Material for) MkDocs is quite nice usually, but for Blender I would expect a fair number of main sections. So I think we need to build our own navigation for these main sections, to keep things scalable. This needs a design.

Landing Page Design

Tasks:

  • Basic setup (configuration, plugins, folder-structure, etc.)
  • Set up Git LFS?
  • New buildbot worker for auto-deployment
  • Custom landing page
  • Custom navigation
  • Blender developer header (navigation between projects.blender.org, devtalk, docs, code blog)
  • Licensing page
  • Contributing page (build instructions, process etc.)
  • Redirects for old links (esp. release notes if these are moved)

Note some basic setup is available under JulianEisel/devdocs already, this can probably be copied into the official repository.

Open topic: Deprecate the Wiki

If we want to replace the Wiki entirely, a few points need attention:

  • Where do the release notes go?
  • How do we deal with storage (GBs of images for release notes, etc.)?
  • How to handle personal pages & weekly reports?
    • Maybe move this to personal Wiki pages on projects.blender.org.
    • In the past centralizing this info was discussed too.
  • Old Wiki should probably be archived.

Plan of action

Phase 0: Planning

  • Get buy-in on the new docs like code platform (e.g. presentation at the Blender HQ)
  • Landing page & navigation design.
  • Decide on overal documentation structure.
  • Investigate open questions for replacing Wiki.

Phase 1: Set up new platform

  • Prepare CD pipeline - #107844
  • Get new platform up and running: Git (LFS?) repository, buildbot, MkDocs configuration, etc.
  • Implement custom landing page and page navigation.

Phase 2: Move Developer Documentation

  • Scripts/tools are available to convert the syntax, will need plenty of manual cleanup still.
  • Set up basic developer handbook.
  • Move pictures and other resources.
  • Move release notes & human interface guidelines?

Phase 3: Deprecate Wiki

If we choose to move away from the Wiki entirely, this can be done after the new developer doc infrastructure is in place.

  • Move personal pages to personal projects.blender.org repositories?
  • Are there other pages to move?
  • Archive wiki as read-only.

Other

These are things we should probably do, but are not

## General questions - A Git LFS repository? - Always pull the repository with Blender sources using `make update` (like add-ons)? - (Material for) MkDocs doesn't support a Gitea integration natively (only GitHub, GitLab or Bitbucket). This is used for example to display an "Edit" button linking to the source markdown file in the repository. Can we get that done somehow? - Do we also put developer documentation for other blender.org projects here? Flamenco, websites, infrastructure, ... Adding versioning or translations for the technical documentation probably isn't worth it. However people can build an earlier version from the git repository. ## What needs to be done ### Scalable Navigation Design The navigation generated by (Material for) MkDocs is quite nice usually, but for Blender I would expect a fair number of main sections. So I think we need to build our own navigation for these main sections, to keep things scalable. This needs a design. ### Landing Page Design ### Tasks: - [x] Basic setup (configuration, plugins, folder-structure, etc.) - [x] Set up Git LFS? - [x] New buildbot worker for auto-deployment - [ ] Custom landing page - [ ] Custom navigation - [x] Blender developer header (navigation between projects.blender.org, devtalk, docs, code blog) - [x] Licensing page - [x] Contributing page (build instructions, process etc.) - [x] Redirects for old links (esp. release notes if these are moved) Note some basic setup is available under [JulianEisel/devdocs](https://projects.blender.org/JulianEisel/devdocs) already, this can probably be copied into the official repository. ## Open topic: Deprecate the Wiki If we want to replace the Wiki entirely, a few points need attention: - Where do the release notes go? - How do we deal with storage (GBs of images for release notes, etc.)? - How to handle personal pages & weekly reports? - Maybe move this to personal Wiki pages on projects.blender.org. - In the past centralizing this info was discussed too. - Old Wiki should probably be archived. ## Plan of action ### Phase 0: Planning - Get buy-in on the new docs like code platform (e.g. presentation at the Blender HQ) - Landing page & navigation design. - Decide on overal documentation structure. - Investigate open questions for replacing Wiki. ### Phase 1: Set up new platform - ✅ Prepare CD pipeline - #107844 - Get new platform up and running: Git (LFS?) repository, buildbot, MkDocs configuration, etc. - Implement custom landing page and page navigation. ### Phase 2: Move Developer Documentation - Scripts/tools are available to convert the syntax, will need plenty of manual cleanup still. - Set up basic developer handbook. - Move pictures and other resources. - Move release notes & human interface guidelines? ### Phase 3: Deprecate Wiki If we choose to move away from the Wiki entirely, this can be done after the new developer doc infrastructure is in place. - Move personal pages to personal projects.blender.org repositories? - Are there other pages to move? - Archive wiki as read-only. ### Other These are things we should probably do, but are not
Julian Eisel added the
Type
To Do
label 2023-03-01 18:59:15 +01:00
Julian Eisel added this to the Developer Documentation project 2023-03-01 18:59:16 +01:00

I tested converting a wiki dump to markdown, using mediawiki-to-gfm with some tweaks:
https://projects.blender.org/brecht/wiki-to-markdown

It has many issues but it's a starting point.

I tested converting a wiki dump to markdown, using `mediawiki-to-gfm` with some tweaks: https://projects.blender.org/brecht/wiki-to-markdown It has many issues but it's a starting point.

The migration is completed, see #116055.

The migration is completed, see #116055.
Blender Bot added the
Status
Archived
label 2024-01-29 16:01:28 +01:00
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset System
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Asset Browser Project
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#105349
No description provided.