Closed tamiko closed 1 year ago
This does not seem to be urgent. Postponing.
Hello there,
it seems to me that most of the tasks here have already been solved:
I didn't find the realization of the last task, so I can add it. Should the instruction to find examples be found in the README.md?
I think what @tamiko had in mind for that last task is to explain where users would find the tutorial programs if the library was installed in /usr
via a package manager. I don't actually know where the tutorial programs end up (maybe /usr/share
?) but it would be useful to document that on the wiki page where the Debian/Ubuntu package is describe.
Any help will as always be gratefully accepted!
I wasn't able to fork dealii.wiki, so, I cloned it locally via ssh indicated at the end of the page. Then, after adding the discussed changes, I wasn't able to push without having permission to push directly to the repo. Then how can I contribute to the wiki?
I suggest making the following additions to the Debian_and_Ubuntu.md
:
To install the tutorial steps, proceed with an installation of a documentation library:
apt-get install libdeal.ii-doc
The tutorial steps are in the /usr/share/doc/libdeal.ii-doc
directory. To copy a particular tutorial step into the current folder and run it, proceed with the following commands (for example, step-1):
$ cp -r /usr/share/doc/libdeal.ii-doc/examples/step-1 .
$ cd step-1
$ cmake .
$ make run
However, I would like to add the changes myself since I want to practice the contribution mechanics.
@Darth-Veidim Thanks a lot! Do you by chance have a link to your version of the wiki repository? I am happy to apply these changes directly.
We had to restrict wiki editing sometime earlier last year due to attempted malicious edits.
Hello @tamiko. Do you mean that I need to push the updated wiki to my repositories first and then provide you with a link?
@Darth-Veidim Yup, if you don't mind, simply push the wiki repo to your github account and tell me the URL.
@tamiko, pushed the wiki here.
I would like to ask you, if there are other not complicated tasks that I can work on? I need more practice in contributing for my Simulation Software Engineering class.
You could run a spell checker on the code. I am sure there are typos.
@Darth-Veidim There is also this page https://dealii.org/participate.html and in particular its link to "Starter projects".
Thank you for your suggestions.
@tamiko, is everything alright with my repository?
@Darth-Veidim Looks good. I have added your commit.
Currently we do a somewhat mediocre job at clearly documenting how to install deal.II on Ubuntu/Debian via the package manager.
Todo: