)]}'
{
  "commit": "ef2586a96ab7aff87d7ea4aba171438faaf0e63e",
  "tree": "98619ab42886a1b875862b17239d257630f68864",
  "parents": [
    "e5cef163646ff4592d981aad8eb714ccd3833414"
  ],
  "author": {
    "name": "Ping Zhang",
    "email": "ping.goblue@gmail.com",
    "time": "Fri Dec 05 11:49:15 2025 -0800"
  },
  "committer": {
    "name": "Wang, Fei",
    "email": "fwang12@ebay.com",
    "time": "Fri Dec 05 11:49:15 2025 -0800"
  },
  "message": "[MINOR] add makefile to do docs gen\n\n### What changes were proposed in this pull request?\n\ncreate a makefile to generate docs and later more targets can be added\n\n### Why are the changes needed?\n\ninside the makefile, it uses a python docker container to build / serve docs, so that contributors dont need to install a specific python version, venv etc. (e.g. right now the requirements.txt does not support python 3.12)\n\n### Does this PR resolve a correctness bug?\n\nNo\n\n### Does this PR introduce _any_ user-facing change?\n\nNo\n\n### How was this patch tested?\n\nlocally:\n\n```\n❯ make\nUsage: make \u003ctarget\u003e\n\nTargets:\n  docs-clean    Remove the generated site directory\n  docs-serve    Run mkdocs serve inside Docker and expose DOCS_PORT\n  docs          Build the MkDocs site inside a Python 3.11 container\n  help          Show help for available make targets\n```\n\n```\n❯ make docs\nINFO     -  DeprecationWarning: pkg_resources is deprecated as an API. See https://setuptools.pypa.io/en/latest/pkg_resources.html\n  File \"/usr/local/lib/python3.11/site-packages/mkdocs_macros/context.py\", line 19, in \u003cmodule\u003e\n    import pkg_resources\n  File \"/usr/local/lib/python3.11/site-packages/pkg_resources/__init__.py\", line 98, in \u003cmodule\u003e\n    warnings.warn(\n\nINFO     -  [macros] - Macros arguments: {\u0027module_name\u0027: \u0027main\u0027, \u0027modules\u0027: [], \u0027include_dir\u0027: \u0027\u0027, \u0027include_yaml\u0027: [], \u0027j2_block_start_string\u0027: \u0027\u0027, \u0027j2_block_end_string\u0027: \u0027\u0027, \u0027j2_variable_start_string\u0027: \u0027\u0027, \u0027j2_variable_end_string\u0027: \u0027\u0027, \u0027on_undefined\u0027: \u0027keep\u0027, \u0027on_error_fail\u0027: False, \u0027verbose\u0027: False}\nINFO     -  [macros] - Extra variables (config file): [\u0027social\u0027]\nINFO     -  [macros] - Extra filters (module): [\u0027pretty\u0027]\nINFO     -  Cleaning site directory\nINFO     -  Building documentation to directory: /workspace/site\nINFO     -  The following pages exist in the docs directory, but are not included in the \"nav\" configuration:\n  - configuration/client.md\n  - configuration/columnar-shuffle.md\n  - configuration/ha.md\n  - configuration/master.md\n  - configuration/metrics.md\n  - configuration/network-module.md\n  - configuration/network.md\n  - configuration/quota.md\n  - configuration/worker.md\n  - developers/release.md\nWARNING  -  Documentation file \u0027developers/faulttolerant.md\u0027 contains a link to \u0027../assets/img/revive.svg\u0027 which is not found in the documentation files.\nWARNING  -  Documentation file \u0027developers/faulttolerant.md\u0027 contains a link to \u0027../assets/img/batchrevive.svg\u0027 which is not found in the documentation files.\nWARNING  -  Documentation file \u0027developers/overview.md\u0027 contains a link to \u0027../assets/img/ess.svg\u0027 which is not found in the documentation files.\nWARNING  -  Documentation file \u0027developers/overview.md\u0027 contains a link to \u0027../assets/img/celeborn.svg\u0027 which is not found in the documentation files.\nWARNING  -  Documentation file \u0027developers/shuffleclient.md\u0027 contains a link to \u0027../assets/img/softsplit.svg\u0027 which is not found in the documentation files.\nWARNING  -  Documentation file \u0027developers/storage.md\u0027 contains a link to \u0027../assets/img/reducepartition.svg\u0027 which is not found in the documentation files.\nWARNING  -  Documentation file \u0027developers/storage.md\u0027 contains a link to \u0027../assets/img/mappartition.svg\u0027 which is not found in the documentation files.\nWARNING  -  Documentation file \u0027developers/storage.md\u0027 contains a link to \u0027../assets/img/multilayer.svg\u0027 which is not found in the documentation files.\nWARNING  -  Documentation file \u0027developers/trafficcontrol.md\u0027 contains a link to \u0027../assets/img/backpressure.svg\u0027 which is not found in the documentation files.\nINFO     -  Documentation built in 1.33 seconds\n\n~/code/apache-celeborn dev/pingz-makefile*                                                                                                                       5s apache-celeborn 14:52:43\n```\n\n`make docs-serve` locally\n\u003cimg width\u003d\"3222\" height\u003d\"1154\" alt\u003d\"image\" src\u003d\"https://github.com/user-attachments/assets/dddc02d1-fb4b-423c-be02-c433a766b5c5\" /\u003e\n\nCloses #3540 from pingzh/dev/pingz-makefile.\n\nAuthored-by: Ping Zhang \u003cping.goblue@gmail.com\u003e\nSigned-off-by: Wang, Fei \u003cfwang12@ebay.com\u003e\n",
  "tree_diff": [
    {
      "type": "add",
      "old_id": "0000000000000000000000000000000000000000",
      "old_mode": 0,
      "old_path": "/dev/null",
      "new_id": "7dd76d5c05f30e792fa1dafaabea6cc7e59cdb95",
      "new_mode": 33188,
      "new_path": "Makefile"
    }
  ]
}
