Setup wiki

[JoshHiles]

Description

As a member of the community,
I want a wiki
So that we can read examples, setup & other information to users

Acceptance Criteria

• Installation instructions
• Designing
• Usage
  • Comparison
  • Context
  • Expensive setup
  • Cleaning up
  • Ignoring Mismatches
  • Enabling / Disabling experiments
  • Experiment ramp up
  • Asynchronous usage
  • Testing
  • Handling errors
  • Ignoring results
  • Multiple experiments
• Results
• Finishing
• Contributing
  • Installation
  • Testing
  • PR
• Anything else....

[marblekirby]

I could kick this off on the core-rewrite branch but dont have permission to access the current / create wiki pages.

[M-Zuber]

Do we want a wiki or GH-Pages?

[JoshHiles]

It's a good point, i think the wiki can only be mainained by the contributers but the GitHub pages can be publicly maintained, only caveat is that you have to create another repo for the GitHub pages

[M-Zuber]

They no longer have support for branch based sites?

[JoshHiles]

I'm wrong! https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site we can have a branch for the pages

[marblekirby]

i think we can have a wiki on this github. Should we go with that?

[JoshHiles]

We do have a wiki on this github, it would be nice to add you @marblekirby to the contributors team, what do we think @scientistproject/scientist-net-maintainers

[paulbreen-symphonytalent]

I agree @JoshHiles

[JoshHiles]

I think @shiftkey is the only person able to add people to the contributors team

[shiftkey]

I've promoted @JoshHiles and @M-Zuber to maintainers of that team - that should allow you to add more contributors as needed

[JoshHiles]

Sorry @shiftkey we will need privileges on the scientist project organisation as well to add team members

[shiftkey]

@JoshHiles apologies - you and @M-Zuber are now organization owners

[marblekirby]

Thanks for inviting me to the organisation. Can someone post the link to the existing wiki?

[M-Zuber]

It would be here https://github.com/scientistproject/Scientist.net/wiki
I do not see any actual content though, so maybe the first step is to get the contents of the Readme into the wiki

[marblekirby]

Yes, i found that wiki, with no content, so assumed that wasnt the right one!
I can start populating that with the readme into wiki files.

[marblekirby]

I will do this - just been super busy with paid work!