Manual: Online Editing #73392

Closed
opened 2020-01-25 21:14:52 +01:00 by Aaron Carlisle · 4 comments
Member

One of the disadvantages of moving to sphinx from the wiki is the loss of online editing. There is some interest in modifying some sort of platform to work with our version control system that can allow editing of the manual online. This is intended only for simplistic changes, limited to one file and without file operations i.e. moving and renaming.

There are two sub-optimal systems that might work and one preferred system:

Two suboptimal ways are by using:

The optimal solution that comes to mind is modifying Phabricator to allow editing a file in diffusion then submitting a patch to the differential. This is something currently being worked on upstream: https://secure.phabricator.com/T6008

This is the desirable solution as it could be beneficial to other areas of development and makes the best use out of software that we already use.

One of the disadvantages of moving to sphinx from the wiki is the loss of online editing. There is some interest in modifying some sort of platform to work with our version control system that can allow editing of the manual online. This is intended only for simplistic changes, limited to one file and without file operations i.e. moving and renaming. There are two sub-optimal systems that might work and one preferred system: Two suboptimal ways are by using: - [dillinger ](https://github.com/joemccann/dillinger) - [jupyter ](https://jupyter.readthedocs.io/en/latest/index.html) The optimal solution that comes to mind is modifying Phabricator to allow editing a file in diffusion then submitting a patch to the differential. This is something currently being worked on upstream: https://secure.phabricator.com/T6008 This is the desirable solution as it could be beneficial to other areas of development and makes the best use out of software that we already use.
Author
Member

Changed status from 'Needs Triage' to: 'Confirmed'

Changed status from 'Needs Triage' to: 'Confirmed'
Author
Member

Added subscriber: @Blendify

Added subscriber: @Blendify

Gitea allows for online editing, closing :)

Gitea allows for online editing, closing :)
Blender Bot added
Status
Archived
and removed
Status
Confirmed
labels 2024-01-20 22:54:50 +01:00
Author
Member

It should be noted that there are still a few related todos listed on infrastructure/blender-projects-platform#51

But for the purpose of this report, we can keep this closed.

It should be noted that there are still a few related todos listed on https://projects.blender.org/infrastructure/blender-projects-platform/issues/51 But for the purpose of this report, we can keep this closed.
Sign in to join this conversation.
No Milestone
No project
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-manual#73392
No description provided.