bazelbuild / bazelbuild/bazel

Documentation for performance is fragmented

Open
#11,384 1 comment 0 reactions 0 assignees View on GitHub
help wanted P3 team-Documentation team-Performance type: documentation (cleanup)
Dominant language
Java
Stars
25.8k
Forks
4.6k
Avg merge
2d 20h
Merged PRs (30d)
72

Description

The documentation about performance is in different places:
* https://docs.bazel.build/versions/master/guide.html#profiling
* https://docs.bazel.build/versions/master/skylark/performance.html (some of it doesn't seem specific to Starlark)
* https://docs.bazel.build/versions/master/memory-saving-mode.html

I think it would be useful to consolidate the information in one place.

This blog post may also contain information to put in the documentation: https://filipnikolovski.com/posts/bazel-performance-in-a-ci-environment

Contributor guide

Open the contributing guide

Research direction

Start by comparing the profiling guide, skylark/performance.html, and memory-saving-mode.html, then review the linked CI performance blog post for relevant material. Consolidate the performance information into one documented place, preserving the useful content and making the resulting documentation easy to find.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation, performance
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.