Skip to content

Commit 45b21dd

Browse files
olyagplolyagpl
committed
[GR-31080] Include metadata for the website in user .md documentation files
PullRequest: truffleruby/2641
2 parents 670df7c + bbe7417 commit 45b21dd

19 files changed

+116
-3
lines changed

‎doc/user/compatibility.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Compatibility
5+
permalink: /reference-manual/ruby/Compatibility/
6+
---
17
# Compatibility
28

39
TruffleRuby aims to be fully compatible with the standard implementation of

‎doc/user/debugging.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Debugging Ruby
5+
permalink: /reference-manual/ruby/Debugging/
6+
---
17
# Debugging TruffleRuby
28

39
## Printing Exceptions

‎doc/user/deploying.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Runtime Configurations
5+
permalink: /reference-manual/ruby/RuntimeConfigurations/
6+
---
17
# Deploying TruffleRuby
28

39
If you are attempting to experiment with deploying TruffleRuby to production we would encourage you to contact us so we can help you understand what is possible at the moment and to help solve any issues for you.

‎doc/user/faq.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: FAQ
5+
permalink: /reference-manual/ruby/FAQ/
6+
---
17
# Frequently Asked Questions
28

39
### What is TruffleRuby?

‎doc/user/installing-graalvm.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Using Ruby with GraalVM
5+
permalink: /reference-manual/ruby/InstallingGraalVM/
6+
---
17
# Using TruffleRuby with GraalVM
28

39
[GraalVM](http://graalvm.org/) is the platform on which TruffleRuby runs.
@@ -52,8 +58,7 @@ languages/ruby/lib/truffle/post_install_hook.sh
5258
$(path/to/graalvm/bin/ruby -e 'print RbConfig::CONFIG["prefix"]')/lib/truffle/post_install_hook.sh
5359
```
5460

55-
You can also download the Ruby component (`ruby-installable-...`) manually from
56-
https://github.com/oracle/truffleruby/releases/latest.
61+
You can also download the latest Ruby component (`ruby-installable-...`) manually from [GitHub](https://github.com/oracle/truffleruby/releases/latest).
5762
Then install it with `gu install --file path/to/ruby-installable-...`.
5863

5964
If you are installing Ruby into GraalVM Enterprise, then you need to download the Ruby

‎doc/user/installing-libssl.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Installing `libssl`
5+
permalink: /reference-manual/ruby/Installinglibssl/
6+
---
17
# Installing `libssl`
28

39
TruffleRuby provides the `openssl` module but not the native `libssl` system library that the module uses.

‎doc/user/installing-llvm.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Installing Make and GCC
5+
permalink: /reference-manual/ruby/InstallingLLVM/
6+
---
17
# Installing Make and GCC
28

39
Since TruffleRuby 19.3.0, TruffleRuby ships with its own LLVM toolchain.

‎doc/user/installing-zlib.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Installing `zlib`
5+
permalink: /reference-manual/ruby/Installingzlib/
6+
---
17
# Installing `zlib`
28

39
TruffleRuby provides the `zlib` module but not the native `zlib` system library that the module uses.

‎doc/user/jruby-migration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Migration from JRuby to Ruby
5+
permalink: /reference-manual/ruby/JRubyMigration/
6+
---
17
# Migration from JRuby to TruffleRuby
28

39
When trying TruffleRuby on your gems and applications, you are encouraged to [get in touch with the TruffleRuby team](../../README.md#contact) for help.

‎doc/user/known-cves.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
layout: docs-experimental
3+
toc_group: ruby
4+
link_title: Security
5+
permalink: /reference-manual/ruby/KnownCVEs/
6+
---
17
# Security
28

39
Please report security vulnerabilities via the process outlined in the [reporting vulnerabilities guide](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html).
@@ -28,7 +34,7 @@ Cross-reference with the details on [the MRI website](https://www.ruby-lang.org/
2834
Number | Description | Their Mitigation | Test | Our Mitigation
2935
--- | --- | --- | --- | ---
3036
CVE-2021-28966 | Path traversal in Tempfile on Windows | Sanitization of paths in tmpdir.rb | In `test/mri/tests/test_tmpdir.rb` | Sanitization of paths in tmpdir.rb
31-
CVE-2021-28965 | XML round-trip vulnerability in REXML | Update to REXML 3.2.5 | In ruby/rexml | Update to REXML 3.2.5
37+
CVE-2021-28965 | XML round-trip vulnerability in REXML | Update to REXML 3.2.5 | In ruby/rexml | Update to REXML 3.2.5
3238
CVE-2020-10663 | Unsafe Object Creation Vulnerability in JSON (Additional fix) | [Fix](https://bugs.ruby-lang.org/issues/16698) | [Spec](https://github.com/ruby/spec/pull/764) | The pure Ruby version of JSON we use is safe
3339
CVE-2019-16255 | A code injection vulnerability of Shell#[] and Shell#test | [Fix](https://github.com/ruby/ruby/commit/d6adc68dc9c74a33b3ca012af171e2d59f0dea10) | MRI test | Same
3440
CVE-2019-16254 | HTTP response splitting in WEBrick (Additional fix) | [Fix](https://github.com/ruby/ruby/commit/3ce238b5f9795581eb84114dcfbdf4aa086bfecc) | MRI test | Same

0 commit comments

Comments
 (0)