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

[DOC] Project readme incorrect #4498

Closed
1 of 4 tasks
ashwin-pc opened this issue Jul 5, 2023 · 2 comments
Closed
1 of 4 tasks

[DOC] Project readme incorrect #4498

ashwin-pc opened this issue Jul 5, 2023 · 2 comments
Assignees
Labels
3 - Done Issue is done/complete

Comments

@ashwin-pc
Copy link
Member

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

The project readme today asks the user to install ruby version 2.6 but this does not work and need to be updated to 2.7. With 2.6 installing the bundles results in this error

bundle install             
Your RubyGems version (3.0.9) has a bug that prevents `required_ruby_version` from working for Bundler. Any scripts that use `gem install bundler` will break as soon as Bundler drops support for your Ruby version. Please upgrade RubyGems to avoid future breakage and silence this warning by running `gem update --system 3.2.3`
Fetching gem metadata from http://rubygems.org/............
Resolving dependencies...
Could not find compatible versions

Because every version of ruby-link-checker depends on Ruby >= 2.7
  and Gemfile depends on ruby-link-checker >= 0,
  Ruby >= 2.7 is required.
So, because current Ruby version is = 2.6.6,
  version solving has failed.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.

@Naarcha-AWS Naarcha-AWS added 1 - Backlog Issue: The issue is unassigned or assigned but not started untriaged and removed untriaged 1 - Backlog Issue: The issue is unassigned or assigned but not started labels Jul 6, 2023
@hdhalter hdhalter self-assigned this Jul 6, 2023
@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed untriaged labels Jul 6, 2023
@hdhalter
Copy link
Contributor

hdhalter commented Jul 6, 2023

We are rewriting the contributing and readme files, so this will be addressed there. Thanks for letting us know, @ashwin-pc ! #4416

@hdhalter
Copy link
Contributor

This is updated in the contributing.md file: https://github.com/opensearch-project/documentation-website/blob/main/CONTRIBUTING.md. Thanks @ashwin-pc!

@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Aug 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete
Projects
None yet
Development

No branches or pull requests

3 participants