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

Error in documentation #105

Closed
koenverwimp opened this issue Aug 28, 2020 · 10 comments · Fixed by #106 or #111
Closed

Error in documentation #105

koenverwimp opened this issue Aug 28, 2020 · 10 comments · Fixed by #106 or #111
Assignees
Labels
documentation This is a problem with documentation.

Comments

@koenverwimp
Copy link

Step 10 of this readme is not correct. This is a copy paste issue from the TypeScript documentation:
https://github.com/aws/aws-rfdk/blob/mainline/examples/deadline/All-In-AWS-Infrastructure-Basic/python/README.md

@ddneilson
Copy link
Contributor

Thanks for reaching out. I agree that it looks weird to see a command for a Node.js tool in the middle of a README for a Python application, but that's actually not an error. You'll see the same in our developer guide here: https://docs.aws.amazon.com/rfdk/latest/guide/first-rfdk-app.html#stage-docker-recipes

The reason for the strangeness is that our stage-deadline command-line tool is currently only available in the Node.js package for the RFDK, so you have to use npx to run that command from the Node.js package. We are working on bringing that command-line tool into the Python package for RFDK, but we're not there yet.

@jusiskin
Copy link
Contributor

I think @koenverwimp might be referring to the references to modifying package.json. Those shouldn't be there.

@koenverwimp
Copy link
Author

Yes, it does look strange to me that i have to configure the deadline version in the package.json and as an environment variable? Even if it so, it's not clear. The first RFDK app doesn't mention anything about package.json, and seems to work without it.

@koenverwimp
Copy link
Author

I think the "bin/config.py" should as well be "package/config.py".

@ddneilson
Copy link
Contributor

I think the "bin/config.py" should as well be "package/config.py".

Ah, right you are! Thanks for pointing that out.

@jusiskin jusiskin added the documentation This is a problem with documentation. label Aug 28, 2020
@koenverwimp
Copy link
Author

koenverwimp commented Aug 30, 2020

According to the documentation I have to add my UsageBasedLicenses

"5. Choose your UBL limits and change the value of the ubl_licenses variable in bin/config.py accordingly:
self.ubl_licenses: List[UsageBasedLicense] = [ (e.g. UsageBasedLicense.forMaya(10))] "

It needs to be "UsageBasedLicense.for_maya(10)" in python.

PS: your example is still pointing to aws-rfdk version 0.16.0

@jusiskin
Copy link
Contributor

Thanks for pointing this out and helping fix this for those that follow in your footsteps. I'll put together a follow-up PR for these new findings.

@koenverwimp
Copy link
Author

It would also be great if there was any explanation how to connect with Deadline Monitor to the RCS fleet. Or did i miss something in the documentation? I guess i need to create a PFX file from certificates that i can find in AWS secret manager? But i didnt get it to work so far.

@jusiskin
Copy link
Contributor

It would also be great if there was any explanation how to connect with Deadline Monitor to the RCS fleet.

Agreed - this is important documentation that is missing. I've created a separate issue (#110) to track this.

@jusiskin
Copy link
Contributor

Re-opening this. #106 auto-closed this after merge, but UBL issue was not addressed

@jusiskin jusiskin reopened this Aug 31, 2020
jusiskin added a commit to jusiskin/aws-rfdk that referenced this issue Aug 31, 2020
- fixes aws#105
- The python example app README gave instructions for using the
  TypeScript `UsageBasedLicense` API. Fixed to use the python API.
- Also fix up formatting in README markdown for both example app
  languages
jusiskin added a commit that referenced this issue Sep 8, 2020
…111)

- fixes #105
- The python example app README gave instructions for using the
  TypeScript `UsageBasedLicense` API. Fixed to use the python API.
- Fix up formatting in README markdown for both example app
  languages
- Clarify SSPL instructions unify python and ts examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
3 participants