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

README restructuring (input-output) #241

Merged
merged 4 commits into from Apr 5, 2024

Conversation

andrestoll
Copy link
Contributor

  • deleted README-INPUT-OUTPUT.md
    • added configuration options to main readme
    • added detailed explanations (weighted payloads, post/pre processing) to README-ADVANCED.md
  • moved changelog to its own file

Copy link
Owner

@alexcasalboni alexcasalboni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for contributing 🎉 🙏 only a quick question about the tables formatting :)

| <div style="width:260px">**Parameter**</div> | Description |
|:-----------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **PowerValues**<br>type: _list of numbers_<br>default: [128,256,512,1024,1536,3008] | These power values (in MB) will be used as the default in case no `powerValues` input parameter is provided at execution time | |
| **visualizationURL**<br>type: _string_<br>default: `lambda-power-tuning.show` | The base URL for the visualization tool, you can bring your own visualization tool |
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these cells need to be manually centered horizontally? this looks difficult to maintain. Is there another way to achieve the same?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can format the document to do this, Intellij for example does this on the fly


| <div style="width:260px">**Parameter**</div> | Description |
|:-----------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **lambdaARN** (required)<br/>type: _string_<br/> | Unique identifier of the Lambda function you want to optimize |
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here of course :)

@alexcasalboni alexcasalboni merged commit acbcf36 into alexcasalboni:master Apr 5, 2024
7 of 8 checks passed
@andrestoll andrestoll deleted the doc-input-readme branch April 22, 2024 12:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants