Semanticmediawiki: Provide and update documentation
Target release
3.0 Ongoing task
Issue
Making this now a hard requirement for a release. As to why, see https://github.com/SemanticMediaWiki/SemanticMediaWiki/issues/1365#issuecomment-334902073 and I'm explicitly expect @kghbln __NOT__ to pick this task.
This is a non-developer task, so anyone can contribute and help the project in moving forward so that by the time of a release the documentation is up-to-date.
Unrelated to the task itself but as reference on the documentation issue:
- https://github.com/SemanticMediaWiki/semantic-mediawiki.org/issues/33
- https://github.com/SemanticMediaWiki/semantic-mediawiki.org/issues/38
Tasks
- [x] Check the release notes for links to the
smw@orgwiki and provide necessary template work and place holders to avoid "This page doesn't exist" message - [ ] Check the wikidocu missing task and fix require documentation
PS: I'm happy to answer specific questions to an unclear wording, or extend on the description of a specific PR.
mwjames
All 6 comments
I am doing a tour de force lately but I am still under the impression of loosing ground when it comes to documenting stuff.
kghbln
on 11 Nov 2017
@SemanticMediaWiki/testers If you have got time you could also help adding more documentation about the new version to the wiki. This page provides a list of the features that should probably be documented at the time of the release. If there is something in the list and still tagged here with "wikidocu missing" you can give it a go. Thanks a lot.
kghbln
on 24 Sep 2018
@kghbln in your previous message, I think you mean this page for "wikidocu missing".
jaideraf
on 30 Sep 2018
@kghbln in your previous message, I think you mean this page for "wikidocu missing".
As a matter of fact I meant both closed and open issues with the label. However, now we have both links here. :)
kghbln
on 30 Sep 2018
My recent attempts with the documentation was to make sections shorter, provide more dedicated subpages, and add visual aids, to help users quickly grasp the "What it is about" and isn't overwhelmed by the sheer amount of text that has been the standard for the wiki for years.
[0] is such typical page (no offense to the various editors) where you have to scroll back and forth to catch what this page tries to convey mixing text and examples making it fairly difficult to see what the system has to offer and "How to" transfer the knowledge.
There should be common theme visible among the recent updates to:
- https://www.semantic-mediawiki.org/wiki/Help:Missing_redirect_annotations
- https://www.semantic-mediawiki.org/wiki/Help:Property_group
- https://www.semantic-mediawiki.org/wiki/Help:Mandatory_parent_datatype_inheritance
- https://www.semantic-mediawiki.org/wiki/Help:Upgrade
- https://www.semantic-mediawiki.org/wiki/Help:Replication_monitoring
- https://www.semantic-mediawiki.org/wiki/Help:Duplicate_entities
- https://www.semantic-mediawiki.org/wiki/Help:Factbox
[0] https://www.semantic-mediawiki.org/wiki/Help:Sorting#User_manual
mwjames
on 3 Mar 2019
This is a "To do" within the documentation project.
kghbln
on 21 Aug 2019
Related issues
krabina
路
4Comments
jaideraf
路
3Comments
simontaurus
路
3Comments
WolfgangFahl
路
3Comments
MvGulik
路
4Comments
Most helpful comment
My recent attempts with the documentation was to make sections shorter, provide more dedicated subpages, and add visual aids, to help users quickly grasp the "What it is about" and isn't overwhelmed by the sheer amount of text that has been the standard for the wiki for years.
[0] is such typical page (no offense to the various editors) where you have to scroll back and forth to catch what this page tries to convey mixing text and examples making it fairly difficult to see what the system has to offer and "How to" transfer the knowledge.
There should be common theme visible among the recent updates to:
[0] https://www.semantic-mediawiki.org/wiki/Help:Sorting#User_manual