HackMD
Workgroup - Documentation
tags: workgroup
Workgroup Members
Nicolai, Anatolly, Simon, Daniele
Workgroup Leader
Luis Navarro
Workgroup Goals
- Documentation for django CMS V4
- Maintain and improve the django CMS documentation
Resources
- django CMS documentation
- Django documentation
- The documentation system
- Proposal
- Getting started change ticket
- Project board
General Notes & Ideas
- Housekeeping
- Simplify & clean up documentation
- Remove user guide and setup new page for it
- Restructure Development & Community Section
- Update documentation
- How-To
- Tutorials
- Simplify & clean up documentation
- Proposal by Jacob Rief: Sphinx integration into django-CMS
Meeting log
12.08.2021
- Review tickets
- Create new repository for user guide
05.08.2021
- Review new tickets
- New User Guide - What are the next steps here?
- Separate website?
08.07.2021
Agenda
- Review changes and check status on tasks
Notes
- Anatoly not finished with changes yet
- Proposal by Gabriel to mention ownership of django CMS project by dCA more prominently in documentation
Tasks
https://github.com/django-cms/django-cms/projects/6
01.07.2021
Agenda
- Review changes and check status on tasks
Notes
Tasks
https://github.com/django-cms/django-cms/projects/6
24.06.2021
Agenda
- Gabriel Intro
- Review changes
Notes
New release
New release for RTD based on our repo release tags. https://docs.readthedocs.io/en/stable/versions.html
Version semantics based on pep 440 - https://www.python.org/dev/peps/pep-0440/
I think that our case is about creating new tag for 3.9 and 4.0 versions
You can see existing tags in https://github.com/django-cms/django-cms/releases
I think we need to ask in contributors workgroup and if it's ok - make new release or let them do it
-> Next steps: Wait to for 3.9 to be released (probably going to happen next week)
Default login/password
As I see we already have it in related article
https://docs.django-cms.org/en/latest/introduction/01-install.html
Username: admin
Password: admin
Changelog review
Candidates to adding to documentation release 3.9
Feature - Added ability to set placeholder global limit on children only (#6847) (18e146495) – G3RB3N
Tasks
https://github.com/django-cms/django-cms/projects/6
17.06.2021
Tasks
- Anatoly to investigate how to add release-3.9.x to documentation
- Anatoly review changelog
- add information about default user name /admin admin to documentation
11.06.2021
- Work on tasks
Tasks
- The docs need a release-3.9.x version. I believe this version needs to be activated in RTD
- Daniele suggests to use Furo rather than continuing to base work on the (older) Divio docs theme
- Review changed "Contributor Guidelines"
- [Nicolai] review changed documentation and check for consistency
20.05.2021
- Review doc changes
Tasks
13.05.2021
Tasks
- [Nicolai] create ticket for first changes according to proposal
- [Anatoly] implement changes according to Nicolai's ticket
06.05.2021
Tasks
- Nicolai to ask Daniele about 2nd documentation project
29.04.2021
Tasks
22.04.2021
- Review of pending PR
- Decided to use draw.io to draw out user journey for documentation to have an understanding of how to change the strucute of the documentation.
Tasks
15.04.2021
- Review of upcoming PR -> approved
- Good documentation reference -> Vuejs
Tasks
08.04.2021
- Review of merged PR with additional committs
- Status update of current tasks -> agreement on next steps:
- Anatoly to focus on developer documentation. Identificiation of mistakes & improvements by going through the documentation step by step and by following instructions
- Nicolai to focus on "Contribute" section
Tasks
- Nicolai to ask Andrew to reply on Anatoly's comment in PR
- Add changes from CONTRIBUTING.rst also to documentation
01.04.2021
Meeting notes
- Reviewed PR of Anatolly
Tasks
- Follow the documentation and check for errors
- Anatolly to check for developer documentation
- Nicolai to check user guide
18.03.2021
Meeting notes
- Anatolly to start working on the tasks of the proposal
Tasks
- Get familiar with the documentation framework (Anatolly)
- Anatolly to get familiar with documentation process (Anatolly)
- Nicolai to make a proposal for restructuring Community & Development section (what should be removed / what should stay) (Nicolai)
