Free as in Freedom: Codeberg.org. Create your repos!

#33 Documentation and HOW-TOs

Open
opened 2 months ago by hw · 4 comments
hw commented 2 months ago

To get new users started, to facilitate workflow and clarify issues for experienced users, documentation and HOWTOs seem helpful.

We might start them in a dedicated repo, potentially publish them as static pages?

To get new users started, to facilitate workflow and clarify issues for experienced users, documentation and HOWTOs seem helpful. We might start them in a dedicated repo, potentially publish them as static pages?
hjacobs commented 1 month ago

We could also use the excellent and community-driven readthedocs.io service for documentation. I think his might be more valuable than re-creating another documentation hosting site which needs to be maintained (even if it is just a script triggering the rebuild+publish of static pages).

We could also use the excellent and community-driven [readthedocs.io service](https://readthedocs.org/) for documentation. I think his might be more valuable than re-creating another documentation hosting site which needs to be maintained (even if it is just a script triggering the rebuild+publish of static pages).
hw commented 1 month ago
Owner

:) we need content!

:) we need content!
hjacobs commented 1 month ago

Let’s start with some simple “getting started” guide explaining how to register, upload SSH key, and create a repo?

If you want I can set up a Sphinx or Mkdocs repo (depends on personal preference) with publishing to readthedocs.io and some first content. Simple example of what I’m talking about: https://pykube.readthedocs.io (source repo is https://github.com/hjacobs/pykube/tree/master/docs)

Let's start with some simple "getting started" guide explaining how to register, upload SSH key, and create a repo? If you want I can set up a Sphinx or Mkdocs repo (depends on personal preference) with publishing to readthedocs.io and some first content. Simple example of what I'm talking about: https://pykube.readthedocs.io (source repo is https://github.com/hjacobs/pykube/tree/master/docs)
hw commented 1 month ago
Owner

Good idea! Even a set of simple markdown files in a repo would be a good start, those we can then format into any suitable format.

(This would have the advantage that editors can use Gitea’s builtin WYSIWYG editor for markdown files, and Sphinx can read those too, if the appropriate plugin is installed. Also gitea’s wiki can directly import/export pages as md).

Good idea! Even a set of simple markdown files in a repo would be a good start, those we can then format into any suitable format. (This would have the advantage that editors can use Gitea's builtin WYSIWYG editor for markdown files, and Sphinx can read those too, if the appropriate plugin is installed. Also gitea's wiki can directly import/export pages as md).
Sign in to join this conversation.
No Milestone
No Assignees
2 Participants
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
Cancel
Save
There is no content yet.