Some wiki content issues

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
T33
Posts: 11
Joined: Sun Oct 11, 2020 8:55 am

Some wiki content issues

Post by T33 »

Found 2 more errors in the wiki.

Page:
https://wiki.freecadweb.org/Power_users_hub

1. The links in the Pivy section don't work.
The first is partly due to to the fact that coin3d.org website has been retired and it's content 'moved' / spread over several github pages:
https://coin3d.github.io/
https://github.com/coin3d/coin
https://github.com/coin3d/coin/wiki
https://github.com/coin3d/pivy

Remove or update this part of the page:

Code: Select all

    Basic Pivy tutorial : A very simple tutorial from the official Pivy site
    Introducing Pivy into studierstube : A document that is not really a tutorial, but that illustrates well how Pivy works


Page: https://wiki.freecadweb.org/Pivy

2. I wondered why the documentation pages of Pivy were different.
It turns out that the top link from 'University of Colorado' shows the old 3.0 documentation of coin3d.
I suggest removing "Coin3D Documentation, at University of Colorado." and keeping the bitbucket one.

In this part of the page:

Code: Select all

Coin3D Documentation, at University of Colorado.
Coin3D Documentation, at BitBucket.
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Some wiki content issues

Post by Kunda1 »

Sounds good.

For #2 I think keep the old link but label it obsolete ?
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
T33
Posts: 11
Joined: Sun Oct 11, 2020 8:55 am

Re: Some wiki content issues

Post by T33 »

Kunda1 wrote: Sun Oct 11, 2020 11:43 am Sounds good.

For #2 I think keep the old link but label it obsolete ?
yeah that works too.
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Some wiki content issues

Post by Kunda1 »

T33 wrote: Sun Oct 11, 2020 12:01 pm yeah that works too.
Go for it :)
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
T33
Posts: 11
Joined: Sun Oct 11, 2020 8:55 am

Re: Some wiki content issues

Post by T33 »

Okay, I made all the appropriate changes in the wiki as discussed above.
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Some wiki content issues

Post by Kunda1 »

Thanks, looks good!
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
vocx
Veteran
Posts: 5197
Joined: Thu Oct 18, 2018 9:18 pm

Re: Some wiki content issues

Post by vocx »

T33 wrote: Sun Oct 11, 2020 10:29 am ...
It turns out that the top link from 'University of Colorado' shows the old 3.0 documentation of coin3d.
I suggest removing "Coin3D Documentation, at University of Colorado." and keeping the bitbucket one.
Exactly in which way is this information obsolete?

The last version of Coin in BitBucket was a 3.1.15, or something like that. When the repository moved from BitBucket to GitHub the maintainers decided to finally bump the version number from v3.x to v4.x. However, the programming interface of v4.0 is essentially the same as the last 3.x version, so any documentation that you use for the v3.x version will work fine. The University of Colorado link appears at the top in search results so it's not bad.

Anyway, the official documentation now seems to be in this page, https://github.com/coin3d/coin/wiki/Documentation. The information there is essentially the same as the 3.x version.
Always add the important information to your posts if you need help. Also see Tutorials and Video tutorials.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
User avatar
Kunda1
Veteran
Posts: 13434
Joined: Thu Jan 05, 2017 9:03 pm

Re: Some wiki content issues

Post by Kunda1 »

vocx wrote: Sun Oct 11, 2020 7:09 pm Exactly in which way is this information obsolete?
Good point. Obsolete would be a misrepresentation.

@T33 just delineate each link by version number.
Make sure to include https://github.com/coin3d/coin/wiki/Documentation
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
vocx
Veteran
Posts: 5197
Joined: Thu Oct 18, 2018 9:18 pm

Re: Some wiki content issues

Post by vocx »

Kunda1 wrote: Sun Oct 11, 2020 7:31 pm ...
Make sure to include https://github.com/coin3d/coin/wiki/Documentation
Already did.
Always add the important information to your posts if you need help. Also see Tutorials and Video tutorials.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
T33
Posts: 11
Joined: Sun Oct 11, 2020 8:55 am

Re: Some wiki content issues

Post by T33 »

vocx wrote: Sun Oct 11, 2020 8:47 pm
Kunda1 wrote: Sun Oct 11, 2020 7:31 pm ...
Make sure to include https://github.com/coin3d/coin/wiki/Documentation
Already did.
Nice, it looks better now.

Ow I just tested your change and it seems you made a typo in the link, since it has a comma at the end and said GiHub instead of GitHub.

Code: Select all

* [https://github.com/coin3d/coin/wiki/Documentation, Coin3D wiki documentation], at GiHub.
I changed it to:

Code: Select all

* [https://github.com/coin3d/coin/wiki/Documentation Coin3D wiki documentation], at GitHub.
Post Reply