Skip to content

Commit

Permalink
feat: translated getting_started and sidebar
Browse files Browse the repository at this point in the history
  • Loading branch information
nodematerial committed Apr 29, 2024
1 parent 7a1f687 commit 1dfb9da
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 26 deletions.
20 changes: 10 additions & 10 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<!-- markdownlint-disable -->

* [Getting Started](/getting_started.md)
* [Playbook](/playbook.md)
* [はじめに](/getting_started.md)
* [プレイブック](/playbook.md)
<a rel="noopener" href="https://github.com/sponsors/test-prof" class="sponsor-link" target="_blank">
<img class='sponsor-badge' src='/assets/images/heart.svg' alt='heart' />
<span>Sponsor</span>
<span>スポンサー</span>
</a>

* Profilers
* プロファイラ
* [Ruby profilers](/profilers/ruby_profilers.md)
* [Event Profiler](/profilers/event_prof.md)
* [Tag Profiler](/profilers/tag_prof.md)
Expand All @@ -16,15 +16,15 @@
* [RSpecDissect Profiler](/profilers/rspec_dissect.md)
* [Memory Profiler](/profilers/memory_prof.md)

* Recipes
* レシピ
* [`before_all` Hook](/recipes/before_all.md)
* [`let_it_be` Helper](/recipes/let_it_be.md)
* [AnyFixture](/recipes/any_fixture.md)
* [FactoryDefault](/recipes/factory_default.md)
* [FactoryAllStub](/recipes/factory_all_stub.md)
* [RSpec Stamp](/recipes/rspec_stamp.md)
* [Tests Sampling](/recipes/tests_sampling.md)
* [Rails Logging](/recipes/logging.md)
* [RSpec スタンプ](/recipes/rspec_stamp.md)
* [テストのサンプリング](/recipes/tests_sampling.md)
* [Rails のロギング](/recipes/logging.md)

* Misc
* [RuboCop cops](/misc/rubocop.md)
* その他
* [RuboCop の検査ルール](/misc/rubocop.md)
34 changes: 18 additions & 16 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,55 @@
# Getting Started
# はじめに

## Installation
## インストール

Add `test-prof` gem to your application:
`test-prof` gem をアプリケーションに追加してください。

```ruby
group :test do
gem "test-prof", "~> 1.0"
end
```

That's it! Now you can use TestProf [profilers](/#profilers).
これだけで完了です。TestProfを使用する準備ができました! [プロファイル](/#profilers).

## Configuration
## 設定

TestProf global configuration is used by most of the profilers:
TestProf には、全ツールで使用されるグローバル設定がいくつかあります。

```ruby
TestProf.configure do |config|
# the directory to put artifacts (reports) in ('tmp/test_prof' by default)
# レポートなどを保存するフォルダー (デフォルトは'tmp/test_prof')
config.output_dir = "tmp/test_prof"

# use unique filenames for reports (by simply appending current timestamp)
# レポートに対し一意なファイル名を付与する(単に、現在のタイムスタンプを追加する)
config.timestamps = true

# color output
# 色付きで出力する
config.color = true

# where to write logs (defaults)
# ログの出力先 (デフォルト)
config.output = $stdout

# alternatively, you can specify a custom logger instance
# あるいは、カスタムのロガーインスタンスを指定することもできます
config.logger = MyLogger.new
end
```

You can also dynamically add artifacts/reports suffixes via `TEST_PROF_REPORT` env variable.
It is useful if you're not using timestamps and want to generate multiple reports with different setups and compare them.
また、「`TEST_PROF_REPORT`」という環境変数を使用して、レポート名に識別子を追加することができます。
これは、異なるセットアップ間でレポートを比較したい場合に役立ちます。

For example, let's compare tests load time with and without `bootsnap` using [`stackprof`](./profilers/stack_prof.md):
**例:** `bootsnap`を使う場合と使わない場合のロード時間を[`stackprof`](./profilers/stack_prof.md)で比較してみましょう。

```sh
# Generate first report using `-with-bootsnap` suffix
# 一番目のレポートに、接頭語「-with-bootsnap」を付けます
$ TEST_STACK_PROF=boot TEST_PROF_REPORT=with-bootsnap bundle exec rake
$ #=> StackProf report generated: tmp/test_prof/stack-prof-report-wall-raw-boot-with-bootsnap.dump


# bootsnapを無効にし、二番目のレポートを作成したい
# Assume that you disabled bootsnap and want to generate a new report
$ TEST_STACK_PROF=boot TEST_PROF_REPORT=no-bootsnap bundle exec rake
$ #=> StackProf report generated: tmp/test_prof/stack-prof-report-wall-raw-boot-no-bootsnap.dump
```

Now you have two stackprof reports with clear names!
これで、分かりやすい名前のレポートが二つできました。

0 comments on commit 1dfb9da

Please sign in to comment.