Skip to content
This repository has been archived by the owner on Jul 21, 2023. It is now read-only.

Suggestions on improving README and .env files #335

Open
shawnsp opened this issue Aug 5, 2021 · 1 comment
Open

Suggestions on improving README and .env files #335

shawnsp opened this issue Aug 5, 2021 · 1 comment
Labels
C-refactoring Category: technical improvement D-easy Difficulty: easy, no design or architectural changes required T-documentation Theme: documentation

Comments

@shawnsp
Copy link
Contributor

shawnsp commented Aug 5, 2021

These suggestions came from my experience setting up Clowdr:

  1. AWS README

    1. In step 4: cp cdk.context.json.example cdk.context.json
    2. AWS Configuration: make XXXX as default values for "clowdr/openShotKeyPairName" and "clowdr/openShotCertificateArn"
  2. Realtime README

    1. cp .env.example .env
    2. In services/realtime/.env, uncomment
      RABBITMQ_USERNAME
      RABBITMQ_PASSWORD
  3. Packetriot
    Add playout subdomain on:
    1. Packetriot account
    2. JSON object template on main README

  4. Auth 0

    1. order numberring is confusing.
    2. HASURA_URL value needs to be https
  5. playout .env
    Add AWS_CLOUDFORMATION_NOTIFICATIONS_TOPIC_ARN

@shawnsp shawnsp added the M-needs-triage Meta: needs triage label Aug 5, 2021
@rossng rossng added C-refactoring Category: technical improvement D-easy Difficulty: easy, no design or architectural changes required T-documentation Theme: documentation and removed M-needs-triage Meta: needs triage labels Aug 19, 2021
@rossng
Copy link
Member

rossng commented Aug 19, 2021

AWS README

In step 4: cp cdk.context.json.example cdk.context.json
AWS Configuration: make XXXX as default values for "clowdr/openShotKeyPairName" and "clowdr/openShotCertificateArn"

We should be ripping out all references to OpenShot. We don't use it right now and it's highly unlikely that it's coming back.

Realtime README

cp .env.example .env

Yep, fair. Will get round to this at some point or will accept PR.

In services/realtime/.env, uncomment
RABBITMQ_USERNAME
RABBITMQ_PASSWORD

Same. Though I think it's better to just uncomment them in the .env.example rather than telling the user to do it manually.

Packetriot
Add playout subdomain on:

  1. Packetriot account

I don't think the actions/realtime service are documented like this in the README either. Looks like we just tell you to use your own domain, which means there's no need to reserve subdomains from Packetriot. I know you have been using Packetriot's domains for your work, but I don't want to just duplicate their documentation. I'd suggest just mentioning this at a high level and linking to their doc pages.

  1. JSON object template on main README

Yep, happy to accept a PR there.

Auth 0

order numberring is confusing.
HASURA_URL value needs to be https

Also happy to accept a PR for these.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
C-refactoring Category: technical improvement D-easy Difficulty: easy, no design or architectural changes required T-documentation Theme: documentation
Development

No branches or pull requests

2 participants