Wiki - Joint forces to keep the wiki a valuable source of information

Community
, , , ,
1

As stated…

The Wiki can be used to extend the information given in the official documentation, with step by step guides, tips and tricks, general recommendations and best practices/strategies, things that are out of the scope of the official docs, etc. For NS8, NethSecurity…

How can you help?

Review old entries

  • Check if the information of wiki pages is current, if it only applies to NS7 (or even previous versions) and if there’s any relevant NS8 information that can be included.
  • As NS7 is defunct (kind of), consider adding a deprecation note/warning where needed.
  • To have in mind: the wiki stores an history of changes, so old information still can be retrieved. That’s interesting, for instance, to (maybe in 6 months or in a year, to say something…) have the main wiki pages updated with just NS8 info but keep NS7 history (some NS7 servers might be around for longer than we expect).

Community Apps

  • Keep an updated index of NS8 apps (and repos) maintained by community members. As we did with NS7.
  • One wiki page per each NS8 community app (for starters, it can be the same info as in the readme file of the app, but can be extended over time with other useful information). You can check examples from NS7 wiki pages.

Unified Knowledge Base

On the community forum there is many NS8 information scattered around that could be ported to the wiki.
Here’s a small and incomplete list of topics -with no specific order- that are susceptible to be included in the wiki (extend it as you wish):

  • If possible, test it to verify the information is correct and add it to the wiki with any missing steps.
  • For any customization, add a deprecation note whenever the feature is officially implemented on NS8, and required steps to undo the changes, if any.

Ideas

  • In my opinion, information related to migration procedures, tips and troubleshooting could be prioritized over other topics. Currently migration appears to be the main source of frustrations; while documenting things it is possible you find bugs or think of improvements that can be reported to devs; (…)
  • Don’t underestimate some small commands given by devs or other members (log location info, config files location info inside apps, different ways to check logs, etc.) that are scattered around the forums. Remember the useful command wiki sections…
  • If you are testing NS8, migration et all, consider sharing some of your notes on the wiki. Doesn’t matter if they aren’t completely pristine as long as they are accurate. If there’s something missing, like proper formatting and screenshots, not complete step by step for dummies et al and you cannot do it alone, publish in on the wiki (adding some warning note to readers) and ask for some help here in the forums. Although not granted, it’s quite possible someone chimes in as time allows.
11 Likes
2

Very valuable post, thanks for that. Maybe a controversial idea, but we could also consider to start a community wiki, where we as a community can shape our info with regards to NS8 and Nethsecurity and leave NS7 as it is.

1 Like