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

Document project setup and meta-information #1

Closed
12 tasks done
blauks opened this issue Feb 6, 2021 · 13 comments
Closed
12 tasks done

Document project setup and meta-information #1

blauks opened this issue Feb 6, 2021 · 13 comments
Assignees
Labels
documentation Improvements or additions to documentation
Projects

Comments

@blauks
Copy link
Contributor

blauks commented Feb 6, 2021

README.md

  • Title
  • (Logo and stats if we are feeling cheeky)
  • Two-three sentences about the project
  • How to set up the project
  • How to run the project

LICENSE

  • Add Apache 2 license

Wiki

  • Frontpage with links to subpages
  • Document CI
  • Document architecture
  • Folder structure
  • Testing
  • Code style
@blauks blauks added this to To do in Overview via automation Feb 6, 2021
@blauks blauks added the documentation Improvements or additions to documentation label Feb 6, 2021
@blauks blauks self-assigned this Feb 6, 2021
@blauks
Copy link
Contributor Author

blauks commented Feb 6, 2021

License added directly to master 🙂

@blauks blauks added this to the Initial project setup milestone Feb 6, 2021
@FredrikAugust FredrikAugust changed the title Start on documentation Document project setup and meta-information Feb 8, 2021
@FredrikAugust
Copy link
Contributor

Updated issue with more information.

@IT2901-SINTEF01/police any input here regarding extra information?

@FredrikAugust
Copy link
Contributor

FredrikAugust commented Feb 12, 2021

I see

TBD

in the wiki pages about testing and CI. These decisions have been made as far as I'm aware.

If content will be added at a later date, use "TK"[0].

[0] https://en.wikipedia.org/wiki/To_come_(publishing)


Furthermore @blauks, any ETA on this? Would be great if we could have it done by the day if possible – and even better if it could be resolved before 12:00 PM.

@blauks
Copy link
Contributor Author

blauks commented Feb 12, 2021

I will probably be able write the pages within today👍

@FredrikAugust
Copy link
Contributor

Perfect.

@FredrikAugust
Copy link
Contributor

Is this done?

@blauks
Copy link
Contributor Author

blauks commented Feb 15, 2021

The issue as a whole is not done yet. Is the contributing.md file really necessary? We basically mention all the relevant things in the wiki.

@FredrikAugust
Copy link
Contributor

No.

Documenting the architecture, however, is;) Feel free to close the issue once you're done!

@emilom
Copy link
Contributor

emilom commented Feb 15, 2021

I will write about architecture now. Should I mostly write about React, GraphQL/Apollo?

@FredrikAugust
Copy link
Contributor

Important subjects:

  • GraphQL+Apollo
  • Storybook
  • Caching in Apollo? Might have to do some research here. It's very easy to set up

@emilom
Copy link
Contributor

emilom commented Feb 15, 2021

Will we be using Apollo for state management as well?

@FredrikAugust
Copy link
Contributor

This is something you may decide internally in @IT2901-SINTEF01/frontend, but I assume it will suffice in the foreseeable future.

@blauks
Copy link
Contributor Author

blauks commented Feb 15, 2021

Finished!

@blauks blauks closed this as completed Feb 15, 2021
Overview automation moved this from In progress to Done Feb 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

3 participants