Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Commands doc

Đang mở
  • Có gì không ổn?
#3,314 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Lĩnh vực
cli, documentation

Hướng nghiên cứu

Bắt đầu bằng cách tải xuống archive All GA Features mới nhất, giải nén và xem lại output trợ giúp cho featureUtility, springBootUtility, auditUtility và serverSchemaGen từ wlp/bin. Thêm tài liệu cho các command được ưu tiên, đảm bảo phần trợ giúp dòng lệnh được ghi trong tài liệu khớp với trợ giúp khi chạy thực tế; issue này không bao gồm các command còn lại trong phạm vi.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

epic

There are other commands than just the ones we've documented so far. I don't know how urgent it is to document them all (they all have commandline help anyway) but just so you know...

Here's the full list of the commands in OL 20.0.0.12 (the .bat files are for Windows, the ones without suffix are for UNIX/Linux, etc):

laura@Lauras-MacBook-Pro openliberty-200012 % ls wlp/bin 
auditUtility		binaryLog		ddlGen			jaxb			pluginUtility.bat	securityUtility.bat	serverSchemaGen.bat
auditUtility.bat	binaryLog.bat		ddlGen.bat		jaxrs			productInfo		server			springBootUtility
batchManager		client			featureUtility		jaxws			productInfo.bat		server.bat		springBootUtility.bat
batchManager.bat	client.bat		featureUtility.bat	pluginUtility		securityUtility		serverSchemaGen		tools

To find them:

  1. Download the latest "All GA Features" zip from https://www.openliberty.io/downloads/
  2. Extract the zip file into a directory on your laptop (I created a dir called openliberty-200012).
  3. At a command prompt/terminal, move into Liberty's bin directory, eg: cd openliberty-200012/wlp/bin
  4. List the contents of the bin directory: ls
    And there you go.

You can get the help for any of the commands by typing the command's name followed by --help, eg: ./binaryLog --help. You'll see some commands you recognise in there, like server, and securityUtility.

The text in this cmdline help should match the text in the OL docs (if you add the help to the OL docs).

For extra credit (and ease of maintenance), rather than duplicating and keeping in sync, ideally someone would create something to generate the your asciidoc pages from the runtime help files according to some template you define. And then you could raise a PR to fix up the wording in the commandline help in future if you want changes to it for style or whatever.

Update on what I've said above after speaking with Alasdair:

  • the online help for the commands should be good enough that we won't lose anything if not all the commands are documented
  • of the commands in Open Liberty, it would be good to doc the following ones:
    • featureUtility
    • springBootUtility
    • auditUtility
  • I'll add to that the serverSchemaGen command, which he's previously said is useful. Info is currently only in the KC I raised an issue on the runtime to get that fixed.
  • all the other commands are low priority

I think if we consider the scope of this issue's work to just be those three commands, rather than all of them, it's probably ok to manually add them to the docs (rather than trying to get them generated automatically, which would take a fair amount of work, including working out a template of how the info should look etc). Leave the rest of the commands (if there's a need in future, the info is in the online help anyway).

Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
14
Fork
58
Merge trung bình
1 giờ 4 phút
Pull request đã merge (30 ngày)
21

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của OpenLiberty/docs

Tất cả issue của OpenLiberty/docs

Issue tương tự

Thêm issue về CLI

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.