Skip to content

Commit fbb7ba9

Browse files
olyagplolyagpl
committed
Remove front matter from user docs
1 parent 47b0c3c commit fbb7ba9

26 files changed

+7
-196
lines changed

‎doc/user/benchmarking.md

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

93
This document lists the most important points to consider when benchmarking TruffleRuby.

‎doc/user/compatibility.md

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

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

‎doc/user/debugging.md

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

93
TruffleRuby, like other GraalVM languages, supports 2 standard debugging protocols:

‎doc/user/deploying.md

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

93
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: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: FAQ
5-
permalink: /reference-manual/ruby/FAQ/
6-
---
71
# Frequently Asked Questions
82

93
### What is TruffleRuby?

‎doc/user/installing-graalvm.md

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

93
This documentation has moved to [Installing TruffleRuby](installing-truffleruby.md).

‎doc/user/installing-libssl.md

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

93
TruffleRuby provides the `openssl` gem but not the native `libssl` system library that the gem uses.

‎doc/user/installing-libyaml.md

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

93
TruffleRuby requires to have `libyaml` installed, much like CRuby 3.2+ and Psych 5+.

‎doc/user/installing-llvm.md

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

93
Since TruffleRuby 24.0.0, TruffleRuby no longer needs a LLVM toolchain and instead uses the system toolchain.

‎doc/user/installing-truffleruby.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,9 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Installing TruffleRuby
5-
permalink: /reference-manual/ruby/InstallingTruffleRuby/
6-
---
71
# Installing TruffleRuby
82

93
The recommended way to install TruffleRuby is via your Ruby manager/installer, see [Getting Started](../../README.md#getting-started).
104

115
You can also install TruffleRuby by manually downloading the binary tarball, extracting it, running the post-install script and adding TruffleRuby to `$PATH`.
12-
This page documents the URLs and the extra steps necessary after downloading the tarball.
6+
This page documents the URLs and the extra steps necessary after downloading the tarball.
137

148
## Dependencies
159

@@ -45,7 +39,7 @@ truffleruby-VERSION-PLATFORM.tar.gz
4539
truffleruby-community-VERSION-PLATFORM.tar.gz
4640
```
4741

48-
Development builds are [also available](https://github.com/ruby/truffleruby-dev-builder/releases/latest).
42+
Development builds are [also available](https://github.com/ruby/truffleruby-dev-builder/releases/latest).
4943
More platforms for dev builds are [available here](https://github.com/graalvm/graalvm-ce-dev-builds/releases/latest) but those builds tend to be slightly older.
5044
The Native Standalones are the files `truffleruby-community-dev-PLATFORM.tar.gz`.
5145

‎doc/user/installing-zlib.md

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

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

‎doc/user/jruby-migration.md

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

93
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: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Security
5-
permalink: /reference-manual/ruby/KnownCVEs/
6-
---
71
# Security
82

93
Please report security vulnerabilities via the process outlined in the [reporting vulnerabilities guide](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html).

‎doc/user/optcarrot.md

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

93
## Running the Demo

‎doc/user/options.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: TruffleRuby Options and Command Line
5-
permalink: /reference-manual/ruby/Options/
6-
---
71
# TruffleRuby Options and Command Line
82

93
TruffleRuby has the same command-line interface as our compatible MRI version.
@@ -84,13 +78,13 @@ Languages:
8478
8579
Tools:
8680
[id] [name] [website]
87-
agentscript Agent Script
81+
agentscript Agent Script
8882
coverage Code Coverage https://www.graalvm.org/tools/code-coverage/
8983
cpusampler CPU Sampler https://www.graalvm.org/tools/profiling/
9084
cputracer CPU Tracer https://www.graalvm.org/tools/profiling/
9185
dap Debug Protocol Server https://www.graalvm.org/tools/dap/
92-
heap Heap Dump
93-
heapmonitor Heap Allocation Monitor
86+
heap Heap Dump
87+
heapmonitor Heap Allocation Monitor
9488
insight Insight https://www.graalvm.org/tools/graalvm-insight/
9589
inspect Chrome Inspector https://www.graalvm.org/tools/chrome-debugger/
9690
lsp Language Server https://www.graalvm.org/tools/lsp/

‎doc/user/polyglot.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Polyglot Programming
5-
permalink: /reference-manual/ruby/Polyglot/
6-
---
71
# Polyglot Programming
82

93
TruffleRuby allows you to interface with any other Truffle language to create polyglot programs -- programs written in more than one language.
@@ -277,7 +271,7 @@ Conceptually it is similar to running multiple Ruby interpreters in the same pro
277271
This can also be used with other languages, so for instance the outer/default context might run some Ruby code and some inner contexts run JavaScript code.
278272
This is very useful to interoperate with languages which do not support shared-memory multithreading like JavaScript, as one can then create one or more inner contexts per thread and still have the outer context use multithreaded Ruby.
279273

280-
Objects from an inner context can be passed to other contexts and they are treated as foreign objects:
274+
Objects from an inner context can be passed to other contexts and they are treated as foreign objects:
281275
```ruby
282276
Polyglot::InnerContext.new do |context|
283277
context.eval('ruby', "p Object.new") # prints #<Object:0xd8>

‎doc/user/reporting-performance-problems.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Reporting Performance Problems
5-
permalink: /reference-manual/ruby/ReportingPerformanceProblems/
6-
---
71
# Reporting Performance Problems
82

93
We are interested in hearing from you if you experience lower performance with TruffleRuby than with other implementations of Ruby.

‎doc/user/ruby-managers.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Ruby Managers and Installers
5-
permalink: /reference-manual/ruby/RubyManagers/
6-
---
71
# Ruby Managers and Installers
82

93
TruffleRuby is supported by all major Ruby installers.

‎doc/user/standalone-distribution.md

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

93
This documentation has moved to [Installing TruffleRuby](installing-truffleruby.md).

‎doc/user/testing-truffleruby-in-ci.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Testing TruffleRuby in CI
5-
permalink: /reference-manual/ruby/TestingTruffleRubyInCI/
6-
---
71
# Testing TruffleRuby in CI
82

93
## Testing TruffleRuby in GitHub Actions

‎doc/user/thread-safe-extensions.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Thread-Safe Extensions
5-
permalink: /reference-manual/ruby/ThreadSafeExtensions/
6-
---
71
# Thread-Safe Extensions
82

93
Native extensions are by default considered thread-unsafe for maximum compatibility with CRuby and use the global extension lock (unless `--cexts-lock=false` is used).

‎doc/user/tools.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Development Tools for Ruby
5-
permalink: /reference-manual/ruby/Tools/
6-
---
71
# Development Tools for Ruby
82

93
TruffleRuby ships with tools automatically provided by GraalVM. Run `--help:tools` to see a full list of options.

‎doc/user/truffleruby-additions.md

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

93
TruffleRuby is intended to be usable as a standard Ruby implementation that runs programs developed on other implementations, but it also provides additional functionality beyond that of other implementations.

‎doc/user/utf8-locale.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
layout: docs-experimental
3-
toc_group: ruby
4-
link_title: Setting up a UTF-8 Locale
5-
permalink: /reference-manual/ruby/UTF8Locale/
6-
---
71
# Setting Up a UTF-8 Locale
82

93
You need a UTF-8 locale to run some Ruby applications.

‎tool/generate-user-doc.rb

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎tool/jt.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2854,7 +2854,7 @@ def check_documentation_urls
28542854
hardcoded_urls.each_line do |line|
28552855
abort "Could not parse #{line.inspect}" unless /(.+?):(\d+):.+?(https:.+?)(#[\w-]+)?[ "'\n]/ =~ line
28562856
file, line, url = $1, $2, $3
2857-
if !%w[tool/jt.rb tool/generate-user-doc.rb].include?(file) and !known_hardcoded_urls.include?(url)
2857+
if !%w[tool/jt.rb].include?(file) and !known_hardcoded_urls.include?(url)
28582858
puts "Found unknown hardcoded url #{url} in #{file}:#{line}, add it in tool/jt.rb"
28592859
status = false
28602860
end

0 commit comments

Comments
 (0)