From e2ec31cd19284f7cc75b071f8a6006f05a468faa Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sat, 8 Dec 2012 16:13:12 +0100 Subject: [PATCH] doc: rename involved into contributing, and write a first version of this page --- buildtools/Cmake/DefinePackages.cmake | 1 + doc/Doxyfile.in | 2 +- doc/doxygen/advanced.doc | 2 +- doc/doxygen/contributing.doc | 106 ++++++++++++++++++++++++++ doc/doxygen/index.doc | 2 +- doc/doxygen/involved.doc | 11 --- 6 files changed, 110 insertions(+), 14 deletions(-) create mode 100644 doc/doxygen/contributing.doc delete mode 100644 doc/doxygen/involved.doc diff --git a/buildtools/Cmake/DefinePackages.cmake b/buildtools/Cmake/DefinePackages.cmake index df7be24e84..28244c685e 100644 --- a/buildtools/Cmake/DefinePackages.cmake +++ b/buildtools/Cmake/DefinePackages.cmake @@ -533,6 +533,7 @@ set(DOC_SOURCES doc/doxygen/inside_cmake.doc doc/doxygen/inside_extending.doc doc/doxygen/inside_release.doc + doc/doxygen/contributing.doc doc/doxygen/modules.doc doc/doxygen/module-msg.doc doc/doxygen/module-sd.doc diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index c338135674..f6d0b20457 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -676,7 +676,7 @@ INPUT = doxygen/index.doc \ doxygen/inside_cmake.doc \ doxygen/inside_autotests.doc \ doxygen/inside_release.doc \ - doxygen/involved.doc \ + doxygen/contributing.doc \ doxygen/tracing.doc \ doxygen/FAQ.doc \ doxygen/modules.doc \ diff --git a/doc/doxygen/advanced.doc b/doc/doxygen/advanced.doc index 4dbba032d3..614110f384 100644 --- a/doc/doxygen/advanced.doc +++ b/doc/doxygen/advanced.doc @@ -9,6 +9,6 @@ tutorials. - @subpage bindings - @subpage pls - @subpage internals -- @subpage involved +- @subpage contributing */ \ No newline at end of file diff --git a/doc/doxygen/contributing.doc b/doc/doxygen/contributing.doc new file mode 100644 index 0000000000..36670f2805 --- /dev/null +++ b/doc/doxygen/contributing.doc @@ -0,0 +1,106 @@ +/*! @page contributing Contributing to SimGrid + +@tableofcontents + +We are sometimes asked by users how to give back to the project. Here +are some ideas, but if you have new ones, feel free. + +@section contributing_spread Spread the word + +There is many ways to help the SimGrid project. The first and most +natural one is to use it for your research, and say so. Cite +the SimGrid framework in your paper and discuss of its advantages with +your colleagues to spread the word. When we ask for new fundings to +sustain the project, the amount of publications enabled by SimGrid is +always the first question that we get. The more you use the framework, +the better for us. + +We use several systems to detect the scientific publications citing +our work, so actually citing correctly the framework (see +here) +should be enough to get us adding your paper to our list. But if you +remark that your paper is missing on +our +page listing all papers using SimGrid, please say so. Likewise, if +your paper is badly cited, please drop us an email so that we can fix +it. + +Also, help us constituting an active and welcoming user +community. Get subscribed to the mailing lists, and answer the +questions that newcommers have if you can. Point them (gentely ;) to +the relevant part of the documentation on need, and help them becoming +part of our community too. + +Another easy way to help the project is to add a link to the +SimGrid homepage +on your homepage to improve SimGrid's ranking in the search +engines. Internet visibility is a battle where you can make the +difference. This can be done by adding the following html snipet to +your page, that simply renders as Simgrid. + +@verbatim + + Simgrid +@endverbatim + +Or you can prefer this version with a little logo (if you want to +contribute another logo for that, please don't hesitate ;) + + +@verbatim + + Versatile simulation of distributed systems: Grid Simulator, P2P simulator, MPI simulator, Cloud Simulator or HPC Simulator + +@endverbatim + +Finally, if you organize a scientific event where you expect many +potential users, invite us to give a tutorial on SimGrid. We +found that 45 minutes to one hour is sufficient. It allows to explain +the main motivations and outcomes of the project in order to motivate +the attendees get more information on SimGrid, and eventually improve +their scientific habits by using a sound simulation framework. +Here +is an example of such a presentation. + +@section contributing_bugs Reporting (and fixing) any issue you find + +Because of its size and complexity, SimGrid is not perfect and +contains a large amount of glitches and issues. When you find one, +don't assume that it's here because we don't care. It survived only +because nobody told us. We unfortunately cannot endlessly review our +large code and documentation base. So please, report any issue you +find to us, be it a typo in the documentation, a paragraph that +needs to be reworded, a bug in the code or any other problem. The best +way to do so is to open a bug on our +Bug +Tracking System so that we don't forget about it (we have other +obligations too and are sometimes unable to fix bugs right away, no +matter how easy the fix it). The worst way to report such issue is to +go through private emails. These are unreliable, and we are trying to +develop SimGrid openly, so private discussions are to be avoided if +possible. + +If you can provide a patch fixing the issue you report, that's even +better, and often ensures that it will get fixed very soon. + +Of course, a very good way to give back to the SimGrid community is to +help triaging and fixing the bugs that are reported in the BTS. If you +can come up with a patch fixing them, we will be more than happy to +apply your changes so that the entier community enjoys them. + +@section contributing_contrib Contributing features and associated tools + +If you deeply miss a feature in the framework, you should consider +implementing it yourself. That's free software, meaning that you are +free to help yourself. Of course, we'll do our best to assist you in +this task, so don't hesitate to contact us with your idea. + +If you develop an independent tool that is somehow associated to +SimGrid, we'd love helping you gaining visibility by listing it on our +Contrib +section. + +*/ \ No newline at end of file diff --git a/doc/doxygen/index.doc b/doc/doxygen/index.doc index 440774db41..2c4802d752 100644 --- a/doc/doxygen/index.doc +++ b/doc/doxygen/index.doc @@ -22,7 +22,7 @@ - @subpage advanced - @ref bindings - @ref pls - - @ref involved + - @ref contributing - @ref internals - @subpage FAQ diff --git a/doc/doxygen/involved.doc b/doc/doxygen/involved.doc deleted file mode 100644 index e77ed3536d..0000000000 --- a/doc/doxygen/involved.doc +++ /dev/null @@ -1,11 +0,0 @@ -/*! @page involved Getting involved - -This page does not exist yet, and a good way to get involved may be to -first help improving the documentation (FIXME). - -The Bug -Tracking System is probably the best way to help us. Please report -there any issue that you notice, and please help us fixing the bugs. - - -*/ \ No newline at end of file -- 2.20.1