Added Apple Silicon install docs

clowder-framework / clowder

A data management system that allows users to share, annotate, organize and analyze large collections of datasets. It provides support for extensible metadata annotation using JSON-LD and a distribute analytics event bus for automatic curation of uploaded data.

https://clowderframework.org/

University of Illinois/NCSA Open Source License

35 stars 17 forks source link

Added Apple Silicon install docs #339

Closed KastanDay closed 2 years ago

KastanDay commented 2 years ago

Description

Watch a video describing the changes (even at 1.5 or 2x speed): https://www.loom.com/share/7babbf34f5c94e4cbab830d6c685276b

Added Apple Silicon install documentation, and overall improved and fixed the copy using feedback from new users.
Added "how to contribute documentation" so that others can get started as fast as possible.
Updated the changelog to highlight Apple Silicon support.

Review Time Estimate

[ ] Immediately
[ ] Within one week
[x] When possible

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] My change requires, and is indeed, a change to the documentation.
[x] I have updated the CHANGELOG.md.
[x] I have signed the CLA
[x] I have read the CONTRIBUTING document.

KastanDay commented 2 years ago

Hi @robkooper thanks for your feedback on the deprecated "Development Environment" page. In response, does my proposal below sound good to you?

https://www.loom.com/share/570bfa4c5a2445cdbb9d81cd0decd20f

Update: One more wrinkle: I think that bottom “Advanced customization” section should be moved into our existing “Customization” page. I’ve always felt it was out of place, and “Customization” is the perfect home for it. This is nice because now “Installing” is just installing, and “Customization” is just customization. And we still remove the deprecated “Dev environment” page. What about that?

I'll submit another commit with those changes.

KastanDay commented 2 years ago

Okay, all of @robkooper 's requests are implemented and it looks ready to merge to me.

KastanDay commented 2 years ago

I can see the changelog on the current version and on my local after building

Hm, you're right. I don't have a good answer for why it wasn't working for me locally. I tried to avoid these inconsistencies by creating a clean environment using the requirements.txt file that the Github action uses to build the docs.

KastanDay commented 2 years ago

Uhoh, the ReadTheDocs build process failed: https://readthedocs.org/projects/clowder-framework/builds/

It uses a different build script than GitHub Actions, and does not use the requirements.txt file, therefore it failed when a package was not installed.

Do you know how to edit the ReadTheDocs build? I think it's via the readthedocs.org web interface. @lmarini

lmarini commented 2 years ago

There is a setting for specifying where the requirements file is. Let me try that.