Skip to content

Commit 60a1a42

Browse files
authored
GH-1014: [Docs] Fix broken and obsolete links in the README.md (#1015)
## What's Changed Fix broken links in `README.md` file. Remove the unused reference [2]: https://github.com/apache/arrow/blob/main/cpp/README.md. Inline footnote links. Closes #1014.
1 parent 776466e commit 60a1a42

1 file changed

Lines changed: 7 additions & 11 deletions

File tree

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323

2424
The following guides explain the fundamental data structures used in the Java implementation of Apache Arrow.
2525

26-
- [ValueVector](https://arrow.apache.org/docs/java/vector.html) is an abstraction that is used to store a sequence of values having the same type in an individual column.
27-
- [VectorSchemaRoot](https://arrow.apache.org/docs/java/vector_schema_root.html) is a container that can hold multiple vectors based on a schema.
28-
- The [Reading/Writing IPC formats](https://arrow.apache.org/docs/java/ipc.html) guide explains how to stream record batches as well as serializing record batches to files.
26+
- [ValueVector](https://arrow.apache.org/java/current/vector.html) is an abstraction that is used to store a sequence of values having the same type in an individual column.
27+
- [VectorSchemaRoot](https://arrow.apache.org/java/current/vector_schema_root.html#vectorschemaroot) is a container that can hold multiple vectors based on a schema.
28+
- The [Reading/Writing IPC formats](https://arrow.apache.org/java/current/ipc.html) guide explains how to stream record batches as well as serializing record batches to files.
2929

30-
Generated javadoc documentation is available [here](https://arrow.apache.org/docs/java/).
30+
Generated javadoc documentation is available [here](https://arrow.apache.org/java/current/).
3131

3232
## Building from source
3333

@@ -93,7 +93,7 @@ conflicting or duplicate fields set this JVM flag or use the correct static cons
9393

9494
## Java Code Style Guide
9595

96-
Arrow Java follows the Google style guide [here][3] with the following
96+
Arrow Java follows the [Google Java Style Guide](http://google.github.io/styleguide/javaguide.html) with the following
9797
differences:
9898

9999
* Imports are grouped, from top to bottom, in this order: static imports,
@@ -119,12 +119,12 @@ following command run in the project root directory:
119119
mvn -Dlogback.configurationFile=file:<path-of-logback-file>
120120
```
121121

122-
See [Logback Configuration][1] for more details.
122+
See [Logback Configuration](https://logback.qos.ch/manual/configuration.html) for more details.
123123

124124
## Integration Tests
125125

126126
Integration tests which require more time or more memory can be run by activating
127-
the `integration-tests` profile. This activates the [maven failsafe][4] plugin
127+
the `integration-tests` profile. This activates the [Maven Failsafe](https://maven.apache.org/surefire/maven-failsafe-plugin/) plugin
128128
and any class prefixed with `IT` will be run during the testing phase. The integration
129129
tests currently require a larger amount of memory (>4GB) and time to complete. To activate
130130
the profile:
@@ -133,7 +133,3 @@ the profile:
133133
mvn -Pintegration-tests <rest of mvn arguments>
134134
```
135135

136-
[1]: https://logback.qos.ch/manual/configuration.html
137-
[2]: https://github.com/apache/arrow/blob/main/cpp/README.md
138-
[3]: http://google.github.io/styleguide/javaguide.html
139-
[4]: https://maven.apache.org/surefire/maven-failsafe-plugin/

0 commit comments

Comments
 (0)