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

Fix minor typos in documentation #304

Merged
merged 1 commit into from
Nov 29, 2023

Conversation

johnma14
Copy link
Contributor

Fixed minor typos and incorrect links in README.md and STANDARDS.md

@johnma14
Copy link
Contributor Author

Looking at the failing CI tests for mac OS, looks like it is failing here: https://github.com/open-quantum-safe/oqs-provider/blob/mb-newpolicy/.circleci/config.yml#L304 and L307 while trying to pre-install OpenSSL v3.1. Currently the stable version supported for brew install openssl@3 is v3.2. The supported versions for brew install are openssl@3 (which is v3.2), openssl@3.0andopenssl@1.1`. I can open another PR to fix it, if that helps.

@johnma14
Copy link
Contributor Author

johnma14 commented Nov 28, 2023

For reference, this is the PR where the changes were made. @thb-sb fyi

Fixed minor typos and incorrect links in README.md and STANDARDS.md
@johnma14
Copy link
Contributor Author

I just added the [skip ci] tag to skip all CI tests since this is a doc change. So all looks good now but the other issue with the CI tests on mac still exists. OpenSSL v3.2 was just released last week.

@baentsch
Copy link
Member

I can open another PR to fix it, if that helps.

That would be appreciated. Our approach is to immediately fix issues if we know there'd be something breaking (new, full) CI runs: Those should test new oqsprovider contributions, not the CI system.

Copy link
Member

@baentsch baentsch 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 these improvements!

@ghost
Copy link

ghost commented Nov 29, 2023

Hi @johnma14,
Thank you for noticing this issue!
I think we have to update the yaml file to specify @3.2

@johnma14
Copy link
Contributor Author

@baentsch @thb-sb I will go ahead and submit a PR right away to fix it. Thank you.

@baentsch baentsch merged commit d540c28 into open-quantum-safe:main Nov 29, 2023
1 check passed
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 13, 2024
Fixed minor typos and incorrect links in README.md and STANDARDS.md

Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 16, 2024
Fixed minor typos and incorrect links in README.md and STANDARDS.md

Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
Fixed minor typos and incorrect links in README.md and STANDARDS.md

Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
Fixed minor typos and incorrect links in README.md and STANDARDS.md

Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
feventura pushed a commit to EntrustCorporation/oqs-provider that referenced this pull request Mar 17, 2024
Fixed minor typos and incorrect links in README.md and STANDARDS.md

Signed-off-by: Felipe Ventura <felipe.ventura@entrust.com>
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.

2 participants