tango-controls / tango-doc

The official documentation for Tango controls
http://tango-controls.readthedocs.io
8 stars 27 forks source link

howto contribute to documentation #231

Closed PhilLAL closed 4 years ago

PhilLAL commented 5 years ago

Page https://tango-controls.readthedocs.io/en/latest/tutorials-and-howtos/tutorials/documentation-workflow-tutorial.html#sphinx-installation could be updated by replacing virtualenv by python3 -m venv tango-doc for example (see https://docs.python.org/3/tutorial/venv.html).

PhilLAL commented 5 years ago

Related to #232

PhilLAL commented 5 years ago

Perhaps a naming convention could be useful for tango-doc newcomers, for example for:

PhilLAL commented 5 years ago

Several pages contains some materials for contributing:

Shouldn't we merge this into the same page?

piogor commented 4 years ago

@PhilLAL, these documents cross reference, so I am closing this. However, feel free to reopen the issue if you think it is important to have both in the same document. My consideration to keep it as two documents is because one is providing general rules and the other is a workflow tutorial or set of hints not a standard and someone may use another workflow.