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

[guide] ARC Best practices #170

Closed
5 of 6 tasks
Brilator opened this issue Jun 23, 2023 · 0 comments
Closed
5 of 6 tasks

[guide] ARC Best practices #170

Brilator opened this issue Jun 23, 2023 · 0 comments
Assignees
Labels
content Issues that require an addition or adaption of content

Comments

@Brilator
Copy link
Member

Brilator commented Jun 23, 2023

Add a Guides section on "best practices" or "how to work with the ARC"

Most guides and instructions so far are pretty much first steps and "forward" only.
We haven't really addressed what's happening "in the middle" once a user has created an ARC and started using it.

  • syncing practices
    • recommendation for how often to arc sync
  • use of commit messages
    • protocols the development of the ARC, i.e. aligns with the project
    • screenshot of branches
  • practical guide to add "legacy data" #181
  • adding external / unpublished data
    • already covered in FAQ, but might make sense to emphasize this here
  • use of gitignore
    • e.g. to keep sensible, unpublished data from sharing
    • note: files added to gitignore on one machine will neither be synced to the DataHUB nor tracked by version control
    • note: if a file was already in the DataHUB, using gitignore will only keep it from future syncs and not remove it
  • avoiding download of LFS objects to small computers
@Brilator Brilator added the content Issues that require an addition or adaption of content label Jun 23, 2023
@Brilator Brilator self-assigned this Jun 23, 2023
@Brilator Brilator changed the title [tutorial] ARC Best practices [Guides] ARC Best practices Jun 23, 2023
@Brilator Brilator changed the title [Guides] ARC Best practices [guide] ARC Best practices Jun 23, 2023
@Brilator Brilator closed this as completed Jul 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues that require an addition or adaption of content
Projects
None yet
Development

No branches or pull requests

1 participant