Guidelines and HOWTOs/Documentation in wikis: Difference between revisions

Latest revision as of 09:07, 23 December 2018

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 each button do? How to achieve a given operation? These 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 for your internal resources. All your pages 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 from 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 from source or What are the code guidelines or Which contact channel do I use to get started are all valid questions to be answered here.

You can add your schedules, your meeting minutes, the architecture of your program and everything you find relevant. Don't forget to use Phabricator to organize your tasks and to-dos!

Examples

Techbase

https://techbase.kde.org is like Userbase but for external developers.

What it is

For instance, if you wrote a library to deal with maps: you might want to write some tutorials on how to link to the library, get in touch with other users of the library, find the tarballs, etc...

Other examples would be Plasma, by describing how to write a plasmoid based on their tools, or Kirigami, describing how to get started with the kirigami libs.

What it is NOT

Tutorials and general How-Tos in KDE are not supposed to be there => https://community.kde.org
Team work and bugs to fix are not supposed to be there => https://community.kde.org, https://phabricator.kde.org or https://bugs.kde.org

Good Examples

Userbase

https://userbase.kde.org contains your user documentation, the same one that would appear when the user asks for About>Help.

@@ Line 2: / Line 2: @@
 * [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://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 each button do? How to achieve a given operation? These are all questions to be answered there.
 == Community ==
@@ Line 16: / Line 16: @@
 === 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.
+Your project should have a page at https://community.kde.org/Your_Project_Name. This is the entry point for your internal resources. All your pages 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.
+We do not enforce any structure, as you can see from 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.
+''What development environment do I need?'' or ''How do I compile from source'' or ''What are the code guidelines'' or ''Which contact channel do I use to get started'' are all valid questions to be answered here.
-You can put add your schedules, your meeting minutes, the architecture of your program and everything you find relevant. Don't forget to use [[Infrastructure/Phabricator |Phabricator]] do organize your tasks and todos !
+You can add your schedules, your meeting minutes, the architecture of your program and everything you find relevant. Don't forget to use [[Infrastructure/Phabricator |Phabricator]] to organize your tasks and to-dos!
 ; Examples
@@ Line 36: / Line 36: @@
 ; What it is
-For instance, you wrote a library to deal with maps: you might want to write some tutorials of how to link to the library, get in touch with other users of the library, find the tarballs, etc...
+For instance, if you wrote a library to deal with maps: you might want to write some tutorials on how to link to the library, get in touch with other users of the library, find the tarballs, etc...
-Another example would be Plasma writing there how to write a plasmoid based their tools or Kirigami describing how to get started with the kirigami libs.
+Other examples would be Plasma, by describing how to write a plasmoid based on their tools, or Kirigami, describing how to get started with the kirigami libs.
 ; What it is NOT
-* Tutorial about general How-Tos in KDE are not supposed to be there => https://community.kde.org
+* Tutorials and general How-Tos in KDE are not supposed to be there => https://community.kde.org
 * Team work and bugs to fix are not supposed to be there => https://community.kde.org, https://phabricator.kde.org or https://bugs.kde.org
@@ Line 49: / Line 49: @@
 == Userbase ==
-https://userbase.kde.org contains your user documentation, the same that should appear when the user asks for <code>About>Help</code>
+https://userbase.kde.org contains your user documentation, the same one that would appear when the user asks for <code>About>Help</code>.