[opensuse-arm] RFC: Expansion boards in the Wiki
Hey guys, I recently started playing with connecting Raspberry Pi Hats and Arduino Shields to boards and am wondering where/how to document this. Hats may be compatible with multiple boards but may need board-specific instructions for the device tree. I am therefore thinking that an expansion-board-centric page with instructions for one or more boards may be the best approach. For ARM boards we are so far using the flat HCL namespace and a Category:ARM_devices to group them. Should we do the same for shields (HCL:Foo_Shield) and have another Category page to locate them? Or should we have some two-level namespace like HCL:Arduino_Shield/Foo? Another interesting question then is how would we generate a list of compatible expansion boards pages on, say, HCL:Raspberry_Pi2? Would that be possible if we had, e.g., Category:Raspberry_Pi_B+_Connector? Or should we rather manually maintain such bidirectional links? Any thoughts and suggestions appreciated. Cheers, Andreas -- SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton HRB 21284 (AG Nürnberg) -- To unsubscribe, e-mail: opensuse-arm+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-arm+owner@opensuse.org
Helo, On 2016-11-25 13:44, Andreas Färber wrote:
For ARM boards we are so far using the flat HCL namespace and a Category:ARM_devices to group them. Should we do the same for shields (HCL:Foo_Shield) and have another Category page to locate them? Or should we have some two-level namespace like HCL:Arduino_Shield/Foo?
Another interesting question then is how would we generate a list of compatible expansion boards pages on, say, HCL:Raspberry_Pi2? Would that be possible if we had, e.g., Category:Raspberry_Pi_B+_Connector? Or should we rather manually maintain such bidirectional links?
In my experience the autogenerated category pages are the best page organization tool I have seen on a wiki. On the other hand, multilevel categories mess things up if anything. The categories allow adding tags for connector type, tested board compatibility, and whatever you like. Try to do that with page hierarchy. Thanks Michal -- To unsubscribe, e-mail: opensuse-arm+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-arm+owner@opensuse.org
Hi Michal, Am 27.11.2016 um 22:30 schrieb msuchanek:
On 2016-11-25 13:44, Andreas Färber wrote:
For ARM boards we are so far using the flat HCL namespace and a Category:ARM_devices to group them. Should we do the same for shields (HCL:Foo_Shield) and have another Category page to locate them? Or should we have some two-level namespace like HCL:Arduino_Shield/Foo?
Another interesting question then is how would we generate a list of compatible expansion boards pages on, say, HCL:Raspberry_Pi2? Would that be possible if we had, e.g., Category:Raspberry_Pi_B+_Connector? Or should we rather manually maintain such bidirectional links?
In my experience the autogenerated category pages are the best page organization tool I have seen on a wiki. On the other hand, multilevel categories mess things up if anything. The categories allow adding tags for connector type, tested board compatibility, and whatever you like. Try to do that with page hierarchy.
Many thanks for this (lonely) feedback. I see your point about hierarchies and have therefore started to prepare some flat-namespace pages last night: https://en.opensuse.org/HCL:Chistera_Pi https://en.opensuse.org/HCL:3D_Magnetic_Sensor_2Go https://en.opensuse.org/HCL:Current_Sensor_2Go More TBD. For now I linked them manually so they can be found: https://en.opensuse.org/HCL:Raspberry_Pi3#Expansion_boards That's what my question above was about: I do understand we would get some Category:Foo page listing the pages (as for ARM devices) but I wondered whether we could also embed such a list into RPi3 etc. pages like we embed the nice JeOS installation template? Editing some category page just gives me the header text and its category, and Help:Category doesn't say anything either about whether or how that may be possible. So ... just textually link to [[:Category:Foo]]? Any naming suggestions for categories? "Category:Raspberry Pi Hat"? (not so unique) Or "Category:Raspberry Pi B+ connector"? (vs. B, confusing for RPi2/3?) Or rather "Category:Raspberry Pi 40-pin connector"? (vs. 26-pin) "Category:MikroBus connector"? (vs. Click board; e.g., ClearFog) "Category:Euler connector"? (maybe not because it's just Pine64?) "Category:PMod connector"? (not yet needed) "Category:BeagleBone Cape"? "Category:Arduino Shield"? (via ArPi600) Regards, Andreas -- SUSE Linux GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton HRB 21284 (AG Nürnberg) -- To unsubscribe, e-mail: opensuse-arm+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-arm+owner@opensuse.org
Hello, On 2016-11-28 15:04, Andreas Färber wrote:
For now I linked them manually so they can be found: https://en.opensuse.org/HCL:Raspberry_Pi3#Expansion_boards
That's what my question above was about: I do understand we would get some Category:Foo page listing the pages (as for ARM devices) but I wondered whether we could also embed such a list into RPi3 etc. pages like we embed the nice JeOS installation template? Editing some category page just gives me the header text and its category, and Help:Category doesn't say anything either about whether or how that may be possible. So ... just textually link to [[:Category:Foo]]?
You should be able to link to the category page. Embedding a category listing directly in a page may require an extra wiki extension.
Any naming suggestions for categories?
"Category:Raspberry Pi Hat"? (not so unique) Or "Category:Raspberry Pi B+ connector"? (vs. B, confusing for RPi2/3?) Or rather "Category:Raspberry Pi 40-pin connector"? (vs. 26-pin) "Category:MikroBus connector"? (vs. Click board; e.g., ClearFog)
The thing with categories is you can add both or make one the category name and add the other to category description so people can find it with search. Thanks Michal -- To unsubscribe, e-mail: opensuse-arm+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-arm+owner@opensuse.org
On 2016-11-29 07:41, msuchanek wrote:
On 2016-11-28 15:04, Andreas Färber wrote:
Any naming suggestions for categories?
"Category:Raspberry Pi Hat"? (not so unique) Or "Category:Raspberry Pi B+ connector"? (vs. B, confusing for RPi2/3?) Or rather "Category:Raspberry Pi 40-pin connector"? (vs. 26-pin) "Category:MikroBus connector"? (vs. Click board; e.g., ClearFog)
The thing with categories is you can add both or make one the category name and add the other to category description so people can find it with search.
Actually, using the connector for category makes more sense because you can add both base boards and expansion boards to the category. You can then get Click boards as intersection of MikroBus connector and Expansion board with the right Media Wiki extension. Thanks Michal -- To unsubscribe, e-mail: opensuse-arm+unsubscribe@opensuse.org To contact the owner, e-mail: opensuse-arm+owner@opensuse.org
participants (2)
-
Andreas Färber -
msuchanek