Jump to content

Guidelines and HOWTOs/Documentation in wikis: Difference between revisions

From KDE Community Wiki
Ochurlaud (talk | contribs)
Created page with "At KDE we have 3 wikis: * [https://community.kde.org Community]: it contains everything for your team work and the resources for the KDE community. * [https://techbase.kde.org..."
 
Ochurlaud (talk | contribs)
No edit summary
Line 1: Line 1:
At KDE we have 3 wikis:
At KDE we have 3 wikis:
* [https://community.kde.org Community]: it contains everything for your team work and the resources for the KDE community.
* [https://community.kde.org Community]: it contains everything for your team work and the resources for the KDE community. (more on this in the [[#Community | Community chapter]]
* [https://techbase.kde.org Techbase]: it contains the documentation, links and tutorial for your libraries. This is aimed for external developers that use your products. (more on this in the [[#Techbase |Techbase chapter]])
* [https://techbase.kde.org Techbase]: it contains the documentation, links and tutorial for your libraries. This is aimed for external developers that use your products. (more on this in the [[#Techbase |Techbase chapter]])
* [https://userbase.kde.org Userbase]: it contains the user manuals. How to use your application? What does which button? How to achieve a given operation? Theses are all questions to be answered there.
* [https://userbase.kde.org Userbase]: it contains the user manuals. How to use your application? What does which button? How to achieve a given operation? Theses are all questions to be answered there.


== Community ==
== Community ==
https://community.kde.org has two focuses:
* centralizing the KDE resources
* organizing the teamwork on your Project.
=== Community Resources ===
All the KDE resources are documented here.
If you are looking for (or want to add) a tutorial about general procedures in KDE, go under [[Guidelines and HOWTOs]]. You'll find useful information about our [[Infrastructure]], [[Schedules]] and other ways to [[Get Involved]]
=== Projects ===
; Structure
Your project should have a page at https://community.kde.org/Your_Project_Name. This is the entry point of your internal resources. All your page should have the format https://community.kde.org/Your_Project_Name/XXX, with the depth you find relevant.
We do not enforce any structure as you can see in the examples below.
; Content
You have to think about it as the resource for your fellow contributors.
''What development environment do I need?'' or ''How do I compile the source'' or ''What are the code guidelines'' or ''What are the contact channel to get started'' are all valid questions to be answered here.
You can put add your schedules, your meeting minutes, and everything you find relevant. Don't forget to use [[Infrastructure/Phabricator |Phabricator]] do organize your tasks and todos !
; Examples
* [[Amarok]]
* [[KDE_GB]]
* [[Windows]]
* [[Calligra]]
* [[Plasma]]
== Techbase ==
== Techbase ==
== Userbase ==
== Userbase ==

Revision as of 18:15, 27 February 2017

At KDE we have 3 wikis:

  • Community: it contains everything for your team work and the resources for the KDE community. (more on this in the Community chapter
  • Techbase: it contains the documentation, links and tutorial for your libraries. This is aimed for external developers that use your products. (more on this in the Techbase chapter)
  • Userbase: it contains the user manuals. How to use your application? What does which button? How to achieve a given operation? Theses are all questions to be answered there.

Community

https://community.kde.org has two focuses:

  • centralizing the KDE resources
  • organizing the teamwork on your Project.

Community Resources

All the KDE resources are documented here.

If you are looking for (or want to add) a tutorial about general procedures in KDE, go under Guidelines and HOWTOs. You'll find useful information about our Infrastructure, Schedules and other ways to Get Involved

Projects

Structure

Your project should have a page at https://community.kde.org/Your_Project_Name. This is the entry point of your internal resources. All your page should have the format https://community.kde.org/Your_Project_Name/XXX, with the depth you find relevant. We do not enforce any structure as you can see in the examples below.

Content

You have to think about it as the resource for your fellow contributors. What development environment do I need? or How do I compile the source or What are the code guidelines or What are the contact channel to get started are all valid questions to be answered here.

You can put add your schedules, your meeting minutes, and everything you find relevant. Don't forget to use Phabricator do organize your tasks and todos !

Examples

Techbase

Userbase