Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and validate Getting Started to support self-serve installations #2

Open
3 of 5 tasks
tiborauer opened this issue Jul 8, 2021 · 2 comments
Open
3 of 5 tasks

Comments

@tiborauer
Copy link
Member

tiborauer commented Jul 8, 2021

The new website should serve as the first line of support providing as much self-reliance as possible. As a first step, Getting Started should be validated and/or extended.

It is related to the discussion started by @tiborauer in
automaticanalysis/automaticanalysis#229

Tasks:

  • Check content for accuracy and validity
  • Ensure bug-free examples
  • Set up two-tiered examples (tutorial + demonstrations)
  • Extend documentation of examples to ensure self-sufficient "getting started"
  • (optional) Add automatic data retrieval based on the recently implemented CI
@AljenU
Copy link

AljenU commented Nov 10, 2021

Also related to discussion automaticanalysis/automaticanalysis#254

@vijayiyer05
Copy link

vijayiyer05 commented Dec 17, 2021

@tiborauer

After discussion with @AljenU, it's noted the following PRs on the code repository start to address the tasks identified above:

Specifically:

  • Starter examples using aa/SPM only on Linux have been tested with spot-fixes
  • Splitting of examples between tutorials (more basic) & demo has started
  • Tutorial examples have been updated with the beginning user in mind
  • Updates of data retrieval code for CI, including addition to second tutorial

Hopefully these are useful foundational contributions to help towards your goal of updating the Getting Started website.

One possibility to consider is linking these efforts, via auto-generation of markdown from live scripts. Happy to discuss this further.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants