|
[Sponsors] |
[Discussion] Restructuring the Installation page at openfoamwiki.net |
|
LinkBack | Thread Tools | Search this Thread | Display Modes |
May 27, 2012, 11:57 |
[Discussion] Restructuring the Installation page at openfoamwiki.net
|
#1 |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
Greetings to all!
I'm starting this thread to discuss the restructuring of this page: http://openfoamwiki.net/index.php/Installation I know that the wiki page has a discussion page of its own at the wiki, but that's barely read/answered by anyone And I'm honestly becoming very tired of constantly answering almost the same things over and over and over and over.... and not matter how many blog posts I can write, how many answers I write, they'll only postpone what needs to be done: we must restructure the Installation page at the openfoamwiki.net So, to start off (instead of creating havoc and chaos on my own) here is the proposed structure:
Code:
{{#categorytree:OpenFOAM guide|mode=pages}}
Copy-paste-modify instructions is pretty easy, so to me it makes sense to have a page per version/variant. As for Linux distributions, since some details change considerably (e.g. Fedora et al use "module load"), there are two possibilities that should be considered/discussed:
So here it is, the idea I've brewed so far. If this is already in discussion elsewhere... I'm not familiar with it I think there are some details here that escape me, such as "OpenFOAM 2.1.x" being a sub-category of "OpenFOAM on Linux", but I think that this might be overcome by the page title itself. For example, the category tree would look like this:
edit: In case of situations such as Debian and Ubuntu behaving almost identically, a page could be tagged with both categories: "Installing OpenFOAM on Debian" and "Installing OpenFOAM on Ubuntu", for the same page "Installation/Linux/Debian/OpenFOAM 2.1.x". Best regards, Bruno
__________________
Last edited by wyldckat; May 27, 2012 at 12:00. Reason: see "edit:" |
|
May 28, 2012, 12:15 |
|
#2 | |||
Assistant Moderator
Bernhard Gschaider
Join Date: Mar 2009
Posts: 4,225
Rep Power: 51 |
Quote:
Quote:
Quote:
Bernhard |
||||
May 29, 2012, 08:13 |
|
#3 |
Senior Member
Anton Kidess
Join Date: May 2009
Location: Germany
Posts: 1,377
Rep Power: 30 |
Thanks for your initiative Bruno. This is really overdue, there's lots of installation related text on the wiki that is hopelessly outdated, making it hard to find the actual information.
About the category tree, organizing according to OpenFoam versions (as follows) seems more natural to me than the tree you suggested, but I think that's subjective. - Anton
__________________
*On twitter @akidTwit *Spend as much time formulating your questions as you expect people to spend on their answer. |
|
May 29, 2012, 16:36 |
|
#4 | |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
Hi Bernhard and Anton,
@Bernhard: OK, as soon as I can, perhaps next weekend, I'll start hacking away through the pages @Anton: Quote:
[RANT] After the conclusions that were inevitably reached with the Nucleation project, the only logical thing right now is to do documentation in the fully open wiki, instead of overblown scripting - although it was a good exercise - so this way people can learn and experience more about the shell, instead of hogging all of the experience to ourselves [/RANT] Keep ideas coming! Best regards, Bruno
__________________
|
||
May 30, 2012, 04:00 |
|
#5 | ||
Senior Member
Anton Kidess
Join Date: May 2009
Location: Germany
Posts: 1,377
Rep Power: 30 |
Quote:
Does this look better? (I switched 2.1.x and Fedora) Quote:
__________________
*On twitter @akidTwit *Spend as much time formulating your questions as you expect people to spend on their answer. Last edited by akidess; May 30, 2012 at 04:01. Reason: grammar |
|||
August 1, 2012, 17:54 |
|
#6 | |
Member
Shreyas Ragavan
Join Date: Feb 2012
Location: India
Posts: 37
Rep Power: 14 |
Quote:
|
||
August 6, 2012, 19:33 |
|
#7 |
Assistant Moderator
Bernhard Gschaider
Join Date: Mar 2009
Posts: 4,225
Rep Power: 51 |
For practical reasons I'm more in favour of having more general instructions and describing the differences. Because otherwise certain pages might become hopelessly out of date if no one with that specific distro bothers to update them
|
|
August 7, 2012, 07:01 |
|
#8 |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
The problem is if there are several differences... but duly noted
__________________
|
|
August 11, 2012, 18:48 |
|
#9 |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
FYI: I've began the restructuring process.
For now, I'm doing stuff sort-of in the back-doors and not editing the main Installation page. The current entry point is this: http://openfoamwiki.net/index.php/Installation/Linux For now, it seems that we can get 2 types of category tree listings in the same tree (and maybe also possible in separate trees):
I've got the idea that the generic source code installation instructions can be written using templates, which would make it easier to write and maintain a lot of stuff... but it's still too early to decide
__________________
|
|
August 12, 2012, 18:57 |
|
#10 |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
OK, I think the base structure is all laid out: http://openfoamwiki.net/index.php/Installation
The old monolithic page has been copy-pasted and referred to at the top of the page. The category tree seems rather clumsy right now, but the only using sub-categories in the tree lacks detail, while the sub-pages prefix listing mode is hard-coded to 3 columns... oh well, optimum is the enemy of good Next weekend(s) I hope to do the following:
__________________
|
|
May 5, 2013, 13:44 |
|
#11 | |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
Greetings to all!
It's been a while since I gave some feedback on this. The last few days I've been in a bit of a vacation and I managed to focus on taking care of some of the things I wanted to do. This included updating and adding installation instructions, including:
Quote:
Bruno
__________________
|
||
October 26, 2013, 12:17 |
|
#12 |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
Greetings to all!
I was going to open two discussion threads at openfoamwiki.net regarding this, but I think this is a better place for this. The questions are somewhat simple/short:
In review of the previous post, I'm now keeping track of the pages that I still need to finish writing here: http://openfoamwiki.net/index.php/Us...finish_writing Best regards, Bruno
__________________
|
|
October 28, 2013, 19:14 |
|
#13 | ||||
Assistant Moderator
Bernhard Gschaider
Join Date: Mar 2009
Posts: 4,225
Rep Power: 51 |
Quote:
Quote:
__________________
Note: I don't use "Friend"-feature on this forum out of principle. Ah. And by the way: I'm not on Facebook either. So don't be offended if I don't accept your invitation/friend request |
|||||
October 29, 2013, 18:57 |
|
#14 |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
Hi Bernhard,
Many thanks! Then so it shall be:
Best regards, Bruno
__________________
|
|
October 29, 2013, 21:23 |
|
#15 |
Assistant Moderator
Bernhard Gschaider
Join Date: Mar 2009
Posts: 4,225
Rep Power: 51 |
Seriously. That can become a reason for people not contributing "Oh. The mighty Bruno will write a page about this anyway. Then I don't have to make an attempt. Although right now I have the time and the knowledge"
__________________
Note: I don't use "Friend"-feature on this forum out of principle. Ah. And by the way: I'm not on Facebook either. So don't be offended if I don't accept your invitation/friend request |
|
November 1, 2013, 19:43 |
|
#16 |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
Hi Bernhard,
Many thanks! I've gotten the message loud and clear! I'm going to look/search into the wiki and find a good way to change from the point of view of "me me me" to "if you don't know what you could write about, here are some ideas"/"these pages are currently incomplete, feel free to help with anything in it". I know the "HowTo" section already has something like that, but there are other pages (beyond the ones I've started and haven't finished yet ) that still need some help. And there was that new FAQ section on how to help, so I'll have a look into how to sort it all out. Best regards, Bruno
__________________
|
|
November 2, 2013, 12:43 |
|
#17 |
Retired Super Moderator
Bruno Santos
Join Date: Mar 2009
Location: Lisbon, Portugal
Posts: 10,981
Blog Entries: 45
Rep Power: 128 |
And here we go, here's what I've taken care of today:
Best regards, Bruno edit: I didn't manage to gather the inspiration to finish writing the 3 pages. I'll try to have a look into them in a few weekends from now.
__________________
Last edited by wyldckat; November 3, 2013 at 18:05. Reason: see "edit:" |
|
Thread Tools | Search this Thread |
Display Modes | |
|
|
Similar Threads | ||||
Thread | Thread Starter | Forum | Replies | Last Post |
CFX11 + Fortran compiler ? | Mohan | CFX | 20 | March 30, 2011 19:56 |
64bitrhel5 OF installation instructions | mirko | OpenFOAM Installation | 2 | August 12, 2008 19:07 |
Installation problems | shellbell1999 | OpenFOAM Installation | 9 | April 6, 2006 14:29 |