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

Improve Hackathon Documentation #249

Open
buedaswag opened this issue Nov 24, 2022 · 0 comments
Open

Improve Hackathon Documentation #249

buedaswag opened this issue Nov 24, 2022 · 0 comments

Comments

@buedaswag
Copy link
Contributor

buedaswag commented Nov 24, 2022

We need to create documentation on what an instructor needs to deliver for a hackathon

  • overview of CI/CD process to deploy a hackathon
  • how data is split between different files
  • folder structure of hackathon files

We have documentation for instructors working on hackathon 2 - https://ldsa-portal.readthedocs.io/en/latest/hackathon_02.html

This documentation needs improvement.

We should make it easy for someone who did not work with us before to know exactly what they need to deliver in the pull request.

Specifically

  • folder structure
  • how to split the data (nice to have: give examples with pictures)
  • urls should be hidden
@Gustavo-SF Gustavo-SF changed the title Improve hackathon 2 documentation Documentation: Improve Hackathon Documentation Aug 2, 2023
@Gustavo-SF Gustavo-SF changed the title Documentation: Improve Hackathon Documentation Improve Hackathon Documentation Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants