Skip to content

Commit

Permalink
De-incubation cleanup in code, docs, packaging (apache#9108)
Browse files Browse the repository at this point in the history
* De-incubation cleanup in code, docs, packaging

* remove unused docs script
  • Loading branch information
jon-wei authored and gianm committed Jan 3, 2020
1 parent eb124a3 commit aa53917
Show file tree
Hide file tree
Showing 270 changed files with 413 additions and 573 deletions.
2 changes: 1 addition & 1 deletion .backportrc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"upstream": "apache/incubator-druid",
"upstream": "apache/druid",
"branches": [
{ "name": "0.16.0-incubating", "checked": true },
{ "name": "0.17.0-incubating", "checked": true }
Expand Down
8 changes: 4 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
<!-- Thanks for trying to help us make Apache Druid (incubating) be the best it can be! Please fill out as much of the following information as is possible (where relevant, and remove it when irrelevant) to help make the intention and scope of this PR clear in order to ease review. -->
<!-- Thanks for trying to help us make Apache Druid be the best it can be! Please fill out as much of the following information as is possible (where relevant, and remove it when irrelevant) to help make the intention and scope of this PR clear in order to ease review. -->

Fixes #XXXX.

<!-- Replace XXXX with the id of the issue fixed in this PR. Remove this section if there is no corresponding issue. Don't reference the issue in the title of this pull-request. -->

<!-- If you are a committer, follow the PR action item checklist for committers:
https://github.com/apache/incubator-druid/blob/master/dev/committer-instructions.md#pr-and-issue-action-item-checklist-for-committers. -->
https://github.com/apache/druid/blob/master/dev/committer-instructions.md#pr-and-issue-action-item-checklist-for-committers. -->

### Description

Expand Down Expand Up @@ -39,10 +39,10 @@ In each section, please describe design decisions made, including:

This PR has:
- [ ] been self-reviewed.
- [ ] using the [concurrency checklist](https://github.com/apache/incubator-druid/blob/master/dev/code-review/concurrency.md) (Remove this item if the PR doesn't have any relation to concurrency.)
- [ ] using the [concurrency checklist](https://github.com/apache/druid/blob/master/dev/code-review/concurrency.md) (Remove this item if the PR doesn't have any relation to concurrency.)
- [ ] added documentation for new or modified features or behaviors.
- [ ] added Javadocs for most classes and all non-trivial methods. Linked related entities via Javadoc links.
- [ ] added or updated version, license, or notice information in [licenses.yaml](https://github.com/apache/incubator-druid/blob/master/licenses.yaml)
- [ ] added or updated version, license, or notice information in [licenses.yaml](https://github.com/apache/druid/blob/master/licenses.yaml)
- [ ] added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
- [ ] added unit tests or modified existing tests to cover new code paths.
- [ ] added integration tests.
Expand Down
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ When submitting a pull request (PR), please use the following guidelines:
- Make sure your code respects existing formatting conventions. In general, follow
the same coding style as the code that you are modifying.
- For Intellij you can import our code style settings xml: [`druid_intellij_formatting.xml`](
https://github.com/apache/incubator-druid/raw/master/dev/druid_intellij_formatting.xml).
https://github.com/apache/druid/raw/master/dev/druid_intellij_formatting.xml).
- For Eclipse you can import our code style settings xml: [`eclipse_formatting.xml`](
https://github.com/apache/incubator-druid/raw/master/dev/eclipse_formatting.xml).
https://github.com/apache/druid/raw/master/dev/eclipse_formatting.xml).
- Do add/update documentation appropriately for the change you are making.
- If you are introducing a new feature you may want to first write about your idea
for feedback to [[email protected]](https://lists.apache.org/[email protected]). Or create an issue
Expand All @@ -37,29 +37,29 @@ When submitting a pull request (PR), please use the following guidelines:
- Try to keep pull requests short and submit separate ones for unrelated
features, but feel free to combine simple bugfixes/tests into one pull request.
- If you are adding or updating a dependency, be sure to update the version, license, or notice information in
[licenses.yaml](https://github.com/apache/incubator-druid/blob/master/licenses.yaml) as appropriate to help ease
[licenses.yaml](https://github.com/apache/druid/blob/master/licenses.yaml) as appropriate to help ease
LICENSE and NOTICE management for ASF releases.

You can find more developers' resources in [`dev/`](dev) directory.

## GitHub Workflow

1. Fork the apache/incubator-druid repository into your GitHub account
1. Fork the apache/druid repository into your GitHub account

https://github.com/apache/incubator-druid/fork
https://github.com/apache/druid/fork

1. Clone your fork of the GitHub repository

```sh
git clone [email protected]:<username>/incubator-druid.git
git clone [email protected]:<username>/druid.git
```

replace `<username>` with your GitHub username.

1. Add a remote to keep up with upstream changes

```
git remote add upstream https://github.com/apache/incubator-druid.git
git remote add upstream https://github.com/apache/druid.git
```

If you already have a copy, fetch upstream changes
Expand Down Expand Up @@ -100,13 +100,13 @@ You can find more developers' resources in [`dev/`](dev) directory.
Go to your Druid fork main page
```
https://github.com/<username>/incubator-druid
https://github.com/<username>/druid
```
If you recently pushed your changes GitHub will automatically pop up a
`Compare & pull request` button for any branches you recently pushed to. If you
click that button it will automatically offer you to submit your pull-request
to the apache/incubator-druid repository.
to the apache/druid repository.
- Give your pull-request a meaningful title.
- In the description, explain your changes and the problem they are solving.
Expand Down
10 changes: 0 additions & 10 deletions DISCLAIMER

This file was deleted.

4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,9 @@
See the License for the specific language governing permissions and
limitations under the License.

APACHE DRUID (INCUBATING) SUBCOMPONENTS:
APACHE DRUID SUBCOMPONENTS:

Apache Druid (incubating) includes a number of subcomponents with
Apache Druid includes a number of subcomponents with
separate copyright notices and license terms. Your use of the source
code for these subcomponents is subject to the terms and
conditions of the following licenses.
Expand Down
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Apache Druid (incubating)
Apache Druid
Copyright 2019 The Apache Software Foundation

This product includes software developed at
Expand Down
13 changes: 3 additions & 10 deletions README.template
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ under the License.



Apache Druid (incubating) is a high performance analytics data store for event-driven data. More information about Druid
Apache Druid is a high performance analytics data store for event-driven data. More information about Druid
can be found on https://druid.apache.org.

Documentation
Expand All @@ -29,7 +29,7 @@ You can get started with Druid with our quickstart at https://druid.apache.org/d

Build from Source
-----------------
You can build Apache Druid (incubating) directly from source.
You can build Apache Druid directly from source.

Prerequisites:
JDK 8, 8u92+
Expand Down Expand Up @@ -71,13 +71,6 @@ [email protected].

Contributing
------------
If you find any bugs, please file a GitHub issue at https://github.com/apache/incubator-druid/issues.
If you find any bugs, please file a GitHub issue at https://github.com/apache/druid/issues.

If you wish to contribute, please follow the guidelines listed at https://druid.apache.org/community/.


Disclaimer: Apache Druid is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the
Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the
infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful
ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it
does indicate that the project has yet to be fully endorsed by the ASF.
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ public class LazyFileSessionCredentialsProvider implements AWSCredentialsProvide
* in {@link #getUnderlyingProvider()} without worrying about final modifiers
* on the fields of the created object
*
* @see <a href="https://github.com/apache/incubator-druid/pull/6662#discussion_r237013157">
* https://github.com/apache/incubator-druid/pull/6662#discussion_r237013157</a>
* @see <a href="https://github.com/apache/druid/pull/6662#discussion_r237013157">
* https://github.com/apache/druid/pull/6662#discussion_r237013157</a>
*/
@MonotonicNonNull
private volatile FileSessionCredentialsProvider provider;
Expand Down
2 changes: 1 addition & 1 deletion codestyle/spotbugs-exclude.xml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
Some of the bugs will only occur once or twice on the codebase,
while others will occur potentially a lot.
Reference: https://github.com/apache/incubator-druid/pull/7894/files
Reference: https://github.com/apache/druid/pull/7894/files
-->
<FindBugsFilter>
<Bug pattern="AT_OPERATION_SEQUENCE_ON_CONCURRENT_ABSTRACTION"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@

/**
* Helper class for NullHandling. This class is used to switch between SQL compatible Null Handling behavior
* introduced as part of https://github.com/apache/incubator-druid/issues/4349 and the old druid behavior
* introduced as part of https://github.com/apache/druid/issues/4349 and the old druid behavior
* where null values are replaced with default values e.g Null Strings are replaced with empty values.
*/
public class NullHandling
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
/**
* NOTE:
* This class should be deprecated after Druid supports configurable index types on dimensions.
* When that exists, this should be the implementation: https://github.com/apache/incubator-druid/issues/2622
* When that exists, this should be the implementation: https://github.com/apache/druid/issues/2622
*
* This is a stop-gap solution to consolidate the dimension specs and remove the separate spatial
* section in DimensionsSpec.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ public static <T> T writeAtomically(final File file, final File tmpDir, OutputSt
// fsync to avoid write-then-rename-then-crash causing empty files on some filesystems.
// Must do this before "out" or "fileChannel" is closed. No need to flush "out" first, since
// Channels.newOutputStream is unbuffered.
// See also https://github.com/apache/incubator-druid/pull/5187#pullrequestreview-85188984
// See also https://github.com/apache/druid/pull/5187#pullrequestreview-85188984
fileChannel.force(true);
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
* Artisanal, locally-sourced, hand-crafted, gluten and GMO free, bespoke, free-range, organic, small-batch parallel
* merge combining sequence.
*
* See proposal: https://github.com/apache/incubator-druid/issues/8577
* See proposal: https://github.com/apache/druid/issues/8577
*
* Functionally equivalent to wrapping {@link org.apache.druid.common.guava.CombiningSequence} around a
* {@link MergeSequence}, but done in parallel on a {@link ForkJoinPool} running in 'async' mode.
Expand All @@ -60,7 +60,7 @@ public class ParallelMergeCombiningSequence<T> extends YieldingSequenceBase<T>
private static final Logger LOG = new Logger(ParallelMergeCombiningSequence.class);

// these values were chosen carefully via feedback from benchmarks,
// see PR https://github.com/apache/incubator-druid/pull/8578 for details
// see PR https://github.com/apache/druid/pull/8578 for details
public static final int DEFAULT_TASK_TARGET_RUN_TIME_MILLIS = 100;
public static final int DEFAULT_TASK_INITIAL_YIELD_NUM_ROWS = 16384;
public static final int DEFAULT_TASK_SMALL_BATCH_NUM_ROWS = 4096;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ public void addMaybeStartHandler(Handler handler, Stage stage) throws Exception
{
if (!startStopLock.tryLock()) {
// (*) This check is why the state should be changed before startStopLock.lock() in stop(). This check allows to
// spot wrong use of Lifecycle instead of entering deadlock, like https://github.com/apache/incubator-druid/issues/3579.
// spot wrong use of Lifecycle instead of entering deadlock, like https://github.com/apache/druid/issues/3579.
if (state.get().equals(State.STOP)) {
throw new ISE("Cannot add a handler in the process of Lifecycle stopping");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ protected List<String> parseLine(String input)
* Copied from Guava's {@link Splitter#splitToList(CharSequence)}.
* This is to avoid the error of the missing method signature when using an old Guava library.
* For example, it may happen when running Druid Hadoop indexing jobs, since we may inherit the version provided by
* the Hadoop cluster. See https://github.com/apache/incubator-druid/issues/6801.
* the Hadoop cluster. See https://github.com/apache/druid/issues/6801.
*/
private List<String> splitToList(String input)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ public void emit(Event event)
try {
URI uri = uriExtractor.apply(event);
// get() before computeIfAbsent() is an optimization to avoid locking in computeIfAbsent() if not needed.
// See https://github.com/apache/incubator-druid/pull/6898#discussion_r251384586.
// See https://github.com/apache/druid/pull/6898#discussion_r251384586.
HttpPostEmitter emitter = emitters.get(uri);
if (emitter == null) {
try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
* which has the same major version in the same time chunk.
*
* An Overshadowable overshadows another if its root partition range contains that of another
* and has a higher minorVersion. For more details, check https://github.com/apache/incubator-druid/issues/7491.
* and has a higher minorVersion. For more details, check https://github.com/apache/druid/issues/7491.
*/
public interface Overshadowable<T extends Overshadowable>
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ private TimelineObjectHolder<VersionType, ObjectType> timelineEntryToObjectHolde

/**
* This method should be deduplicated with DataSourcesSnapshot.determineOvershadowedSegments(): see
* https://github.com/apache/incubator-druid/issues/8070.
* https://github.com/apache/druid/issues/8070.
*/
public Set<TimelineObjectHolder<VersionType, ObjectType>> findFullyOvershadowed()
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
*/
public class StringUtilsTest
{
// copied from https://github.com/apache/incubator-druid/pull/2612
// copied from https://github.com/apache/druid/pull/2612
public static final String[] TEST_STRINGS = new String[]{
"peach", "péché", "pêche", "sin", "",
"☃", "C", "c", "Ç", "ç", "G", "g", "Ğ", "ğ", "I", "ı", "İ", "i",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -775,7 +775,7 @@ public void testCustomNestedPeriodFail()
}
}

@Test // Regression test for https://github.com/apache/incubator-druid/issues/5200.
@Test // Regression test for https://github.com/apache/druid/issues/5200.
public void testIncrementOverSpringForward()
{
// Sao Paulo daylight savings time in 2017 starts at midnight. When we spring forward, 00:00:00 doesn't exist.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1026,7 +1026,7 @@ public void testNotFoundReturnsEmpty()
Assert.assertTrue(timeline.lookup(Intervals.of("1970/1980")).isEmpty());
}

/** https://github.com/apache/incubator-druid/issues/3010 */
/** https://github.com/apache/druid/issues/3010 */
@Test
public void testRemoveIncompleteKeepsComplete()
{
Expand Down
2 changes: 1 addition & 1 deletion dev/code-review/concurrency.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Improving scalability
https://github.com/code-review-checklists/java-concurrency#long-adder-for-hot-fields)
- [Considered queues from JCTools instead of the standard concurrent queues?](
https://github.com/code-review-checklists/java-concurrency#jctools)
- [Caffeine cache is used instead of Guava?](https://github.com/apache/incubator-druid/issues/8399)
- [Caffeine cache is used instead of Guava?](https://github.com/apache/druid/issues/8399)
- [Can apply speculation (optimistic concurrency) technique?](
https://github.com/code-review-checklists/java-concurrency#speculation)

Expand Down
Loading

0 comments on commit aa53917

Please sign in to comment.