You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The purpose of this informal feasibility study is to address an issue with providing documentation that is relevant to supported versions of the BuddyPress plugin. This study provides a narrow scope of a much larger documentation effort by looking at the viability of utilizing the Slate API Generator tool, a.k.a., Slate Docs, to provide BP REST API end user documentation.
Apparently, the version of Ruby in the package manager isn't high enough to run the following:
sudo gem update --system
ERROR: Error installing rubygems-update:
rubygems-update-3.6.9 requires Ruby version >= 3.1.0. The current ruby version is 3.0.7.220.
ERROR: While executing gem ... (NoMethodError)
undefined method `version' for nil:NilClass
More issues, bundle install produces errors due write permissions. then running with sudo installs but with a warning:
sudo bundle install
Don't run Bundler as root. Installing your bundle as root will break this application for all non-root users on this machine.
It would appear that the path of /usr/share/, by default, only has permissions for root and /usr/share/gems/ is where the bundle install is trying to write. There were additional warnings near the completion of the install:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
0.16.x will be the supporting Ruby 2.x and be feature frozen (only fixes will be released)
For Ruby 3.x use 0.17.x or later (might not be released yet)
Post-install message from sass:
Ruby Sass has reached end-of-life and should no longer be used.
Neither here nor there, after running the command bundle exec middleman server the rendered content can be viewed at http://localhost:4567/ and to halt the middleman server requires a ctrl + c.
Caution
Middleman loads with a warning message regarding sass:
== Sprockets will render css with ruby sass
consider using Sprockets 4.x to render with SassC
Notes with using Docker with AlmaLinux 9
Caution
Building or serving documents locally results with the following warning:
Your RubyGems version (3.0.3.1) 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
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Introduction
The purpose of this informal feasibility study is to address an issue with providing documentation that is relevant to supported versions of the BuddyPress plugin. This study provides a narrow scope of a much larger documentation effort by looking at the viability of utilizing the Slate API Generator tool, a.k.a., Slate Docs, to provide BP REST API end user documentation.
References
Slate repo & documentation
GitHub Repo
Wiki
Markdown Syntax
Slate demo & document source files
Demo - Slate
Example source document - Slate demo
WooCommerce demo & document source files
Live - WooCommerce
WooCommerce REST API Docs - source documents
BuddyPress REST API demo & other related info
Converted to md files - BP REST API V1
Experimental BP REST API Repo utilizing Slate Docs
Live - BP REST API Docs
Observations during Installation and evaluation
Installing Dependencies on Linux - AlmaLinux - Centos 9
Apparently, the version of Ruby in the package manager isn't high enough to run the following:
More issues,
bundle installproduces errors due write permissions. then running with sudo installs but with a warning:It would appear that the path of
/usr/share/, by default, only has permissions for root and/usr/share/gems/is where thebundle installis trying to write. There were additional warnings near the completion of the install:The details of the
bundle installFetching gem metadata from https://rubygems.org/............
Fetching concurrent-ruby 1.2.0
Fetching zeitwerk 2.6.0
Fetching public_suffix 5.0.1
Fetching minitest 5.17.0
Installing zeitwerk 2.6.0
Installing minitest 5.17.0
Installing public_suffix 5.0.1
Installing concurrent-ruby 1.2.0
Fetching execjs 2.7.0
Installing execjs 2.7.0
Fetching backports 3.23.0
Fetching coffee-script-source 1.12.2
Fetching contracts 0.16.1
Installing coffee-script-source 1.12.2
Installing backports 3.23.0
Fetching dotenv 2.8.1
Installing contracts 0.16.1
Installing dotenv 2.8.1
Fetching erubis 2.7.0
Installing erubis 2.7.0
Fetching fast_blank 1.0.1
Installing fast_blank 1.0.1 with native extensions
Fetching fastimage 2.2.6
Installing fastimage 2.2.6
Fetching ffi 1.15.5
Installing ffi 1.15.5 with native extensions
Fetching temple 0.10.0
Installing temple 0.10.0
Fetching tilt 2.0.11
Installing tilt 2.0.11
Fetching hashie 3.6.0
Installing hashie 3.6.0
Fetching rexml 3.2.5
Installing rexml 3.2.5
Fetching rb-fsevent 0.11.2
Fetching memoist 0.16.2
Installing rb-fsevent 0.11.2
Installing memoist 0.16.2
Fetching thor 1.2.1
Fetching padrino-support 0.15.2
Installing thor 1.2.1
Installing padrino-support 0.15.2
Fetching parallel 1.22.1
Fetching rack 2.2.6.2
Installing parallel 1.22.1
Fetching servolux 0.13.0
Installing rack 2.2.6.2
Installing servolux 0.13.0
Fetching parslet 2.0.0
Installing parslet 2.0.0
Fetching webrick 1.8.1
Installing webrick 1.8.1
Fetching rouge 3.30.0
Fetching racc 1.6.0
Installing racc 1.6.0 with native extensions
Installing rouge 3.30.0
Fetching redcarpet 3.6.0
Installing redcarpet 3.6.0 with native extensions
Fetching autoprefixer-rails 10.2.5.0
Installing autoprefixer-rails 10.2.5.0
Fetching uglifier 3.2.0
Installing uglifier 3.2.0
Fetching addressable 2.8.1
Installing addressable 2.8.1
Fetching coffee-script 2.4.1
Installing coffee-script 2.4.1
Fetching i18n 1.6.0
Installing i18n 1.6.0
Fetching tzinfo 2.0.6
Installing tzinfo 2.0.6
Fetching hamster 3.0.0
Installing hamster 3.0.0
Fetching haml 5.2.2
Installing haml 5.2.2
Fetching kramdown 2.4.0
Installing kramdown 2.4.0
Fetching middleman-cli 4.4.3
Installing middleman-cli 4.4.3
Fetching sprockets 3.7.2
Installing sprockets 3.7.2
Fetching toml 0.3.0
Installing toml 0.3.0
Fetching padrino-helpers 0.15.2
Installing padrino-helpers 0.15.2
Fetching activesupport 6.1.6.1
Installing activesupport 6.1.6.1
Fetching nokogiri 1.13.9 (x86_64-linux)
Installing nokogiri 1.13.9 (x86_64-linux)
Fetching rb-inotify 0.10.1
Fetching sassc 2.4.0
Installing rb-inotify 0.10.1
Fetching listen 3.8.0
Fetching sass-listen 4.0.0
Installing sassc 2.4.0 with native extensions
Installing listen 3.8.0
Installing sass-listen 4.0.0
Fetching sass 3.7.4
Installing sass 3.7.4
Fetching middleman-core 4.4.3
Installing middleman-core 4.4.3
Fetching middleman-sprockets 4.1.1
Fetching middleman 4.4.3
Fetching middleman-autoprefixer 3.0.0
Fetching middleman-syntax 3.3.0
Installing middleman-sprockets 4.1.1
Installing middleman 4.4.3
Installing middleman-autoprefixer 3.0.0
Installing middleman-syntax 3.3.0
Bundle complete! 9 Gemfile dependencies, 55 gems now installed.
Use
bundle info [gemname]to see where a bundled gem is installed.Post-install message from i18n:
HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
But that may break your application.
Please check your Rails app for 'config.i18n.fallbacks = true'.
If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
'config.i18n.fallbacks = [I18n.default_locale]'.
If not, fallbacks will be broken in your app by I18n 1.1.x.
For more info see:
https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
Post-install message from contracts:
Post-install message from sass:
Ruby Sass has reached end-of-life and should no longer be used.
If you use Sass as a command-line tool, we recommend using Dart Sass, the new
primary implementation: https://sass-lang.com/install
If you use Sass as a plug-in for a Ruby web framework, we recommend using the
sassc gem: https://github.com/sass/sassc-ruby#readme
For more details, please refer to the Sass blog:
https://sass-lang.com/blog/posts/7828841
Running
bundle oudatedreveals Gems at current installed versions vs latest versions.The details of
bundle outdatedbundle outdated Fetching gem metadata from https://rubygems.org/............ Resolving dependencies...Gem Current Latest Requested Groups
activesupport 6.1.6.1 8.0.2
addressable 2.8.1 2.8.7
autoprefixer-rails 10.2.5.0 10.4.21.0
concurrent-ruby 1.2.0 1.3.5
contracts 0.16.1 0.17.2
dotenv 2.8.1 3.1.8
execjs 2.7.0 2.10.0
fastimage 2.2.6 2.4.0
ffi 1.15.5 1.17.2
haml 5.2.2 6.3.0
hashie 3.6.0 5.0.0
i18n 1.6.0 1.14.7
kramdown 2.4.0 2.5.1
listen 3.8.0 3.9.0
middleman 4.4.3 4.6.0 ~> 4.4 default
middleman-cli 4.4.3 4.6.0
middleman-core 4.4.3 4.6.0
middleman-syntax 3.3.0 3.5.0 ~> 3.2 default
mini_portile2 2.8.0 2.8.9
minitest 5.17.0 5.25.5
nokogiri 1.13.9 1.18.8 ~> 1.13.3 default
padrino-helpers 0.15.2 0.15.3
padrino-support 0.15.2 0.15.3
parallel 1.22.1 1.27.0
public_suffix 5.0.1 6.0.2
racc 1.6.0 1.8.1
rack 2.2.6.2 3.1.15
rb-inotify 0.10.1 0.11.1
redcarpet 3.6.0 3.6.1 ~> 3.6.0 default
rexml 3.2.5 3.4.1
rouge 3.30.0 4.5.2 ~> 3.21 default
sprockets 3.7.2 4.2.2
temple 0.10.0 0.10.3
thor 1.2.1 1.3.2
tilt 2.0.11 2.6.0
uglifier 3.2.0 4.2.1
webrick 1.8.1 1.9.1 >= 0 default
Neither here nor there, after running the command
bundle exec middleman serverthe rendered content can be viewed athttp://localhost:4567/and to halt the middleman server requires actrl + c.Caution
Middleman loads with a warning message regarding sass:
== Sprockets will render css with ruby sassconsider using Sprockets 4.x to render with SassC
Notes with using Docker with AlmaLinux 9
Caution
Building or serving documents locally results with the following warning:
Your RubyGems version (3.0.3.1) has a bug that prevents
required_ruby_versionfrom working for Bundler. Any scripts that usegem install bundlerwill break as soon as Bundler drops support for your Ruby version. Please upgrade RubyGems to avoid future breakage and silence this warning by runninggem update --system 3.2.3Beta Was this translation helpful? Give feedback.
All reactions