Skip to content

[GR-66235] Remove front matter from user docs. #3914

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions doc/user/benchmarking.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Benchmarking TruffleRuby
permalink: /reference-manual/ruby/Benchmarking/
---
# Benchmarking TruffleRuby

This document lists the most important points to consider when benchmarking TruffleRuby.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/compatibility.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Compatibility
permalink: /reference-manual/ruby/Compatibility/
---
# Compatibility

TruffleRuby aims to be fully compatible with the standard implementation of
Expand Down
6 changes: 0 additions & 6 deletions doc/user/debugging.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Debugging Ruby
permalink: /reference-manual/ruby/Debugging/
---
# Debugging TruffleRuby

TruffleRuby, like other GraalVM languages, supports 2 standard debugging protocols:
Expand Down
6 changes: 0 additions & 6 deletions doc/user/deploying.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Runtime Configurations
permalink: /reference-manual/ruby/RuntimeConfigurations/
---
# Deploying TruffleRuby

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.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/faq.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: FAQ
permalink: /reference-manual/ruby/FAQ/
---
# Frequently Asked Questions

### What is TruffleRuby?
Expand Down
6 changes: 0 additions & 6 deletions doc/user/installing-graalvm.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Using Ruby with GraalVM
permalink: /reference-manual/ruby/InstallingGraalVM/
---
# Using TruffleRuby with GraalVM

This documentation has moved to [Installing TruffleRuby](installing-truffleruby.md).
6 changes: 0 additions & 6 deletions doc/user/installing-libssl.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Installing `libssl`
permalink: /reference-manual/ruby/Installinglibssl/
---
# Installing `libssl`

TruffleRuby provides the `openssl` gem but not the native `libssl` system library that the gem uses.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/installing-libyaml.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Installing LibYAML
permalink: /reference-manual/ruby/InstallingLibYAML/
---
# Installing LibYAML

TruffleRuby requires to have `libyaml` installed, much like CRuby 3.2+ and Psych 5+.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/installing-llvm.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Installing Make and GCC
permalink: /reference-manual/ruby/InstallingLLVM/
---
# Installing Make and GCC

Since TruffleRuby 24.0.0, TruffleRuby no longer needs a LLVM toolchain and instead uses the system toolchain.
Expand Down
10 changes: 2 additions & 8 deletions doc/user/installing-truffleruby.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Installing TruffleRuby
permalink: /reference-manual/ruby/InstallingTruffleRuby/
---
# Installing TruffleRuby

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

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

## Dependencies

Expand Down Expand Up @@ -45,7 +39,7 @@ truffleruby-VERSION-PLATFORM.tar.gz
truffleruby-community-VERSION-PLATFORM.tar.gz
```

Development builds are [also available](https://github.com/ruby/truffleruby-dev-builder/releases/latest).
Development builds are [also available](https://github.com/ruby/truffleruby-dev-builder/releases/latest).
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.
The Native Standalones are the files `truffleruby-community-dev-PLATFORM.tar.gz`.

Expand Down
6 changes: 0 additions & 6 deletions doc/user/installing-zlib.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Installing `zlib`
permalink: /reference-manual/ruby/Installingzlib/
---
# Installing `zlib`

TruffleRuby provides the `zlib` module but not the native `zlib` system library that the module uses.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/jruby-migration.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Migration from JRuby to Ruby
permalink: /reference-manual/ruby/JRubyMigration/
---
# Migration from JRuby to TruffleRuby

When trying TruffleRuby on your gems and applications, you are encouraged to [get in touch with the TruffleRuby team](../../README.md#contact) for help.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/known-cves.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Security
permalink: /reference-manual/ruby/KnownCVEs/
---
# Security

Please report security vulnerabilities via the process outlined in the [reporting vulnerabilities guide](https://www.oracle.com/corporate/security-practices/assurance/vulnerability/reporting.html).
Expand Down
6 changes: 0 additions & 6 deletions doc/user/optcarrot.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Optcarrot Example
permalink: /reference-manual/ruby/Optcarrot/
---
# Running Optcarrot

## Running the Demo
Expand Down
12 changes: 3 additions & 9 deletions doc/user/options.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: TruffleRuby Options and Command Line
permalink: /reference-manual/ruby/Options/
---
# TruffleRuby Options and Command Line

TruffleRuby has the same command-line interface as our compatible MRI version.
Expand Down Expand Up @@ -84,13 +78,13 @@ Languages:

Tools:
[id] [name] [website]
agentscript Agent Script
agentscript Agent Script
coverage Code Coverage https://www.graalvm.org/tools/code-coverage/
cpusampler CPU Sampler https://www.graalvm.org/tools/profiling/
cputracer CPU Tracer https://www.graalvm.org/tools/profiling/
dap Debug Protocol Server https://www.graalvm.org/tools/dap/
heap Heap Dump
heapmonitor Heap Allocation Monitor
heap Heap Dump
heapmonitor Heap Allocation Monitor
insight Insight https://www.graalvm.org/tools/graalvm-insight/
inspect Chrome Inspector https://www.graalvm.org/tools/chrome-debugger/
lsp Language Server https://www.graalvm.org/tools/lsp/
Expand Down
8 changes: 1 addition & 7 deletions doc/user/polyglot.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Polyglot Programming
permalink: /reference-manual/ruby/Polyglot/
---
# Polyglot Programming

TruffleRuby allows you to interface with any other Truffle language to create polyglot programs -- programs written in more than one language.
Expand Down Expand Up @@ -277,7 +271,7 @@ Conceptually it is similar to running multiple Ruby interpreters in the same pro
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.
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.

Objects from an inner context can be passed to other contexts and they are treated as foreign objects:
Objects from an inner context can be passed to other contexts and they are treated as foreign objects:
```ruby
Polyglot::InnerContext.new do |context|
context.eval('ruby', "p Object.new") # prints #<Object:0xd8>
Expand Down
6 changes: 0 additions & 6 deletions doc/user/reporting-performance-problems.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Reporting Performance Problems
permalink: /reference-manual/ruby/ReportingPerformanceProblems/
---
# Reporting Performance Problems

We are interested in hearing from you if you experience lower performance with TruffleRuby than with other implementations of Ruby.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/ruby-managers.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Ruby Managers and Installers
permalink: /reference-manual/ruby/RubyManagers/
---
# Ruby Managers and Installers

TruffleRuby is supported by all major Ruby installers.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/standalone-distribution.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Standalone Distribution
permalink: /reference-manual/ruby/StandaloneDistribution/
---
# Standalone Distribution

This documentation has moved to [Installing TruffleRuby](installing-truffleruby.md).
6 changes: 0 additions & 6 deletions doc/user/testing-truffleruby-in-ci.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Testing TruffleRuby in CI
permalink: /reference-manual/ruby/TestingTruffleRubyInCI/
---
# Testing TruffleRuby in CI

## Testing TruffleRuby in GitHub Actions
Expand Down
6 changes: 0 additions & 6 deletions doc/user/thread-safe-extensions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Thread-Safe Extensions
permalink: /reference-manual/ruby/ThreadSafeExtensions/
---
# Thread-Safe Extensions

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).
Expand Down
6 changes: 0 additions & 6 deletions doc/user/tools.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Development Tools for Ruby
permalink: /reference-manual/ruby/Tools/
---
# Development Tools for Ruby

TruffleRuby ships with tools automatically provided by GraalVM. Run `--help:tools` to see a full list of options.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/truffleruby-additions.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Ruby Additional Functionality
permalink: /reference-manual/ruby/TruffleRubyAdditions/
---
# TruffleRuby Additional Functionality

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.
Expand Down
6 changes: 0 additions & 6 deletions doc/user/utf8-locale.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
layout: docs-experimental
toc_group: ruby
link_title: Setting up a UTF-8 Locale
permalink: /reference-manual/ruby/UTF8Locale/
---
# Setting Up a UTF-8 Locale

You need a UTF-8 locale to run some Ruby applications.
Expand Down
45 changes: 0 additions & 45 deletions tool/generate-user-doc.rb

This file was deleted.

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