How to contribute to the wiki?

sph_tudelft_nlsph_tudelft_nl
in DualSPHysics v4.4
Is it possible for users to contribute to the wiki on github? If so, what is the recommended way to do it? Thanks in advance for tips and guidance.

Comments

  • AlexAlex
    We use now the wiki as Users Guide...
    So only developers are now working on that...
    However anything interesting you suggest can be included there.

    Regards
  • sph_tudelft_nlsph_tudelft_nl
    edited April 2019
    I was tempted to just edit the part on the compilation with Linux and make. However, if you just split the compiling section into subsections for compiling with windows and with linux and, then, with make and cmake, this would help speed-read the document.
  • RCanelasRCanelas
    Hey, you can fork the project, create a branch just for your wiki mods, push your changes there to test and then open a pull request to merge your modifications, if they are approved by the repo mods. Cheers!
  • sph_tudelft_nlsph_tudelft_nl
    Thanks for the tip. I will give it a go in the next few weeks
  • sph_tudelft_nlsph_tudelft_nl

    @RCanelas and @whom-it-may-concern

    This is an embed external element. It can be deleted using the delete key or the backspace key. To view the full element, press the preview button below.
    RCanelas
    Hey, you can fork the project, create a branch just for your wiki mods, push your changes there to test and then open a pull request to merge your modifications, if they are approved by the repo mods. Cheers!

    Intriguing idea to collaborate with users and external developers effectively and efficiently.

    However, I see that in GitHub the wiki documentation is handled differently from regular project files. In GitHub every forked project has its own wiki, and it looks like it is a separate git repository, for example https://github.com/DualSPHysics/DualSPHysics.wiki.git against https://github.com/DualSPHysics/DualSPHysics.git I can then create a wiki in my fork and for it only, which is indeed what I see happening with DualSPHysics own repository.

    I am missing a way to pull local changes into the wiki git, considering that it is not tracked by the main project repository? Has anybody tried that out?

    There is some 'magic' discussed in this Stack Overflow post at https://stackoverflow.com/q/10642928 . Which would be the preferred work around for DualSPHysics?

    Otherwise the only solution remains that suggested above by @Alex

    This is an embed external element. It can be deleted using the delete key or the backspace key. To view the full element, press the preview button below.
    Alex
    We use now the wiki as Users Guide...
    So only developers are now working on that...
    However anything interesting you suggest can be included there.

    Regards


  • sph_tudelft_nlsph_tudelft_nl
    edited July 2020

    At the end of the wiki page itself, outside the index, at https://github.com/DualSPHysics/DualSPHysics/wiki#suggestions-and-errors-in-the-wiki, I found this

    image.png

    The link in the "ISSUES section of the repository" is https://github.com/DualSPHysics/DualSPHysics/issues If you open a new issue, having a GitHub account I presume, you get into a form like the image below, with wide possibility to document a contribution:

    image.png

    The 'contributing guidelines' linked to at the bottom of the form are at https://github.com/DualSPHysics/DualSPHysics/blob/master/CONTRIBUTING.md

    This seems to address the question asked at the top. I hope this will help users and developers contribute their insights to the description of DualSPHysics.

Sign In or Register to comment.

Debug Trace

Notice 
rich is deprecated. Use FormatService::renderHtml($content, Formats\RichFormat::FORMAT_KEY) instead.

#0 [internal function]: gdn_ErrorHandler(16384, 'rich is depreca...', '/var/www/forums...', 950, Array)
#1 /var/www/forums-dual-sphysics-org/library/core/functions.general.php(950): trigger_error('rich is depreca...', 16384)
#2 /var/www/forums-dual-sphysics-org/library/core/class.format.php(1729): deprecated('rich', 'FormatService::...')
#3 /var/www/forums-dual-sphysics-org/library/core/class.format.php(1479): Gdn_Format::rich('[{"insert":{"me...')
#4 /var/www/forums-dual-sphysics-org/applications/vanilla/views/discussion/helper_functions.php(24): Gdn_Format::to('[{"insert":{"me...', 'Rich')
#5 /var/www/forums-dual-sphysics-org/applications/vanilla/views/discussion/helper_functions.php(170): formatBody(Object(stdClass))
#6 /var/www/forums-dual-sphysics-org/applications/vanilla/views/discussion/comments.php(19): writeComment(Object(stdClass), Object(DiscussionController), Object(Gdn_Session), 5)
#7 /var/www/forums-dual-sphysics-org/applications/vanilla/views/discussion/index.php(53): include('/var/www/forums...')
#8 /var/www/forums-dual-sphysics-org/library/core/class.controller.php(778): include('/var/www/forums...')
#9 /var/www/forums-dual-sphysics-org/library/core/class.controller.php(1382): Gdn_Controller->fetchView('', false, false)
#10 /var/www/forums-dual-sphysics-org/library/core/class.pluggable.php(217): Gdn_Controller->xRender()
#11 /var/www/forums-dual-sphysics-org/applications/vanilla/controllers/class.discussioncontroller.php(310): Gdn_Pluggable->__call('render', Array)
#12 /var/www/forums-dual-sphysics-org/applications/vanilla/controllers/class.discussioncontroller.php(402): DiscussionController->index(1590, 'x', 'p1')
#13 /var/www/forums-dual-sphysics-org/library/core/class.dispatcher.php(862): DiscussionController->comment('2881')
#14 /var/www/forums-dual-sphysics-org/library/core/class.dispatcher.php(279): Gdn_Dispatcher->dispatchController(Object(Gdn_Request), Array)
#15 /var/www/forums-dual-sphysics-org/index.php(29): Gdn_Dispatcher->dispatch()
#16 {main}
Notice 
rich is deprecated. Use FormatService::renderHtml($content, Formats\RichFormat::FORMAT_KEY) instead.

#0 [internal function]: gdn_ErrorHandler(16384, 'rich is depreca...', '/var/www/forums...', 950, Array)
#1 /var/www/forums-dual-sphysics-org/library/core/functions.general.php(950): trigger_error('rich is depreca...', 16384)
#2 /var/www/forums-dual-sphysics-org/library/core/class.format.php(1729): deprecated('rich', 'FormatService::...')
#3 /var/www/forums-dual-sphysics-org/library/core/class.format.php(1479): Gdn_Format::rich('[{"insert":"At ...')
#4 /var/www/forums-dual-sphysics-org/applications/vanilla/views/discussion/helper_functions.php(24): Gdn_Format::to('[{"insert":"At ...', 'Rich')
#5 /var/www/forums-dual-sphysics-org/applications/vanilla/views/discussion/helper_functions.php(170): formatBody(Object(stdClass))
#6 /var/www/forums-dual-sphysics-org/applications/vanilla/views/discussion/comments.php(19): writeComment(Object(stdClass), Object(DiscussionController), Object(Gdn_Session), 6)
#7 /var/www/forums-dual-sphysics-org/applications/vanilla/views/discussion/index.php(53): include('/var/www/forums...')
#8 /var/www/forums-dual-sphysics-org/library/core/class.controller.php(778): include('/var/www/forums...')
#9 /var/www/forums-dual-sphysics-org/library/core/class.controller.php(1382): Gdn_Controller->fetchView('', false, false)
#10 /var/www/forums-dual-sphysics-org/library/core/class.pluggable.php(217): Gdn_Controller->xRender()
#11 /var/www/forums-dual-sphysics-org/applications/vanilla/controllers/class.discussioncontroller.php(310): Gdn_Pluggable->__call('render', Array)
#12 /var/www/forums-dual-sphysics-org/applications/vanilla/controllers/class.discussioncontroller.php(402): DiscussionController->index(1590, 'x', 'p1')
#13 /var/www/forums-dual-sphysics-org/library/core/class.dispatcher.php(862): DiscussionController->comment('2881')
#14 /var/www/forums-dual-sphysics-org/library/core/class.dispatcher.php(279): Gdn_Dispatcher->dispatchController(Object(Gdn_Request), Array)
#15 /var/www/forums-dual-sphysics-org/index.php(29): Gdn_Dispatcher->dispatch()
#16 {main}

© Vanilla Keystone Theme 2025