Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Docs][C++] cpp/README.md refers docs/source/developers/cpp but it just displays a list of files #44416

Closed
hiroyuki-sato opened this issue Oct 15, 2024 · 2 comments
Closed

[Docs][C++] cpp/README.md refers docs/source/developers/cpp but it just displays a list of files #44416

hiroyuki-sato opened this issue Oct 15, 2024 · 2 comments
Assignees
@hiroyuki-sato
Labels
Component: Documentation Type: enhancement
Milestone
19.0.0

Comments

@hiroyuki-sato
Copy link
Contributor

Describe the enhancement requested

Hello, team.

Apache Arrow C++ links to C++ Development Documentation

The linked C++ Development Documentation page does not have a README, it just displays a list of files.

スクリーンショット 2024-10-15 17 20 04

Adding README.md like below may help for developers.

C++ Development Documentation

Component(s)

Documentation
hiroyuki-sato added a commit to hiroyuki-sato/arrow that referenced this issue Oct 15, 2024
@hiroyuki-sato
apacheGH-44416: [Docs] Add C++ Development Documentation index page
bfc1c1d
@kou kou changed the title [Docs][C++] C++ Development Documentation page does not have a list page. [Docs][C++] cpp/README.md refers docs/source/developers/cpp but it just displays a list of files Oct 15, 2024
@kou
Copy link
Member

kou commented Oct 15, 2024

How about changing the link in cpp/README.md to https://arrow.apache.org/docs/dev/developers/cpp/index.html from https://github.com/apache/arrow/blob/main/docs/source/developers/cpp instead of adding a README.md to docs/source/developers/cpp/?

hiroyuki-sato added a commit to hiroyuki-sato/arrow that referenced this issue Oct 16, 2024
@hiroyuki-sato
apacheGH-44416: Update the URL to C++ Development in README.md
b510655
@hiroyuki-sato hiroyuki-sato mentioned this issue Oct 16, 2024
Merged
kou pushed a commit that referenced this issue Oct 16, 2024
@hiroyuki-sato
GH-44416: [C++][Docs] Update the URL to C++ Development in README.md (#…
f6d0dd3 
…44427)

### Rationale for this change

A new developer can find proper documentation more easily.

### What changes are included in this PR?

Change the reference URL link to the official documentation page instead of the GitHub project page.

### Are these changes tested?

Yes.

### Are there any user-facing changes?

No.

* GitHub Issue: #44416

Authored-by: Hiroyuki Sato <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
@kou
Copy link
Member

kou commented Oct 16, 2024

Issue resolved by pull request 44427
#44427

@kou kou added this to the 19.0.0 milestone Oct 16, 2024
@kou kou closed this as completed Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hiroyuki-sato hiroyuki-sato

Labels
Component: Documentation Type: enhancement
Projects
None yet
Milestone
19.0.0
Development

No branches or pull requests
2 participants
@kou @hiroyuki-sato