Skip to content

Commit 9e3f390

Browse files
massakammerlimat
massakam
authored and
merlimat
committed
Add ASF headers to Markdown documentation files (apache#823)
1 parent e92c54a commit 9e3f390

File tree

126 files changed

+2586
-11
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+2586
-11
lines changed

‎.gitignore.swp

12 KB
Binary file not shown.

‎CONTRIBUTORS.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
121

222
#### Initial contributors
323

‎README.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
122
![logo](site/img/pulsar.png)
223

324
Pulsar is a distributed pub-sub messaging platform with a very

‎build/docker/README.md

+19
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,23 @@
1+
<!--
12
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
221

322
This folder contains a Docker image that can used to compile the Pulsar C++ client library
423
and website in a reproducible environment.

‎dashboard/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
121

222
# Pulsar Dashboard
323

‎kubernetes/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
121

222
This directory contains the Kubernetes services definitions for all
323
the components required to do a complete Pulsar deployment.

‎pom.xml

+26-5
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,10 @@ flexible messaging model and an intuitive client API.</description>
608608
<exclude>LICENSE</exclude>
609609
<exclude>NOTICE</exclude>
610610
<exclude>**/*.txt</exclude>
611-
<exclude>**/*.md</exclude>
611+
<exclude>**/*.pem</exclude>
612+
<exclude>**/*.crt</exclude>
613+
<exclude>**/*.key</exclude>
614+
<exclude>**/*.csr</exclude>
612615
<exclude>**/proto/*.java</exclude>
613616
<exclude>bin/proto/*</exclude>
614617
<exclude>**/*.patch</exclude>
@@ -635,18 +638,27 @@ flexible messaging model and an intuitive client API.</description>
635638
<exclude>site/vendor/**</exclude>
636639
<exclude>site/scripts/doxygen/**</exclude>
637640
<exclude>site/api/**</exclude>
638-
<exclude>site/api/**</exclude>
639641
<exclude>site/.sass-cache/**</exclude>
640642
<exclude>site/generated/**</exclude>
641643
<exclude>site/js/jquery.tocify.min.js</exclude>
642644
<exclude>site/js/jquery.scrollTo.min.js</exclude>
645+
<exclude>site/Gemfile.lock</exclude>
646+
<exclude>site/VERSIONS</exclude>
647+
<exclude>site/_sass/bootstrap-sass/**</exclude>
648+
<exclude>site/_sass/font-awesome/**</exclude>
649+
<exclude>site/fonts/**</exclude>
650+
<exclude>site/img/**</exclude>
651+
<exclude>generated-site/**</exclude>
652+
<exclude>.github/*.md</exclude>
643653
</excludes>
644654
<mapping>
645655
<proto>JAVADOC_STYLE</proto>
646656
<conf>SCRIPT_STYLE</conf>
647657
<ini>SCRIPT_STYLE</ini>
648658
<yaml>SCRIPT_STYLE</yaml>
649659
<cc>JAVADOC_STYLE</cc>
660+
<md>XML_STYLE</md>
661+
<scss>JAVADOC_STYLE</scss>
650662
</mapping>
651663
</configuration>
652664
</plugin>
@@ -682,11 +694,20 @@ flexible messaging model and an intuitive client API.</description>
682694
<exclude>licenses/LICENSE-*.txt</exclude>
683695
<exclude>src/assemble/README.bin.txt</exclude>
684696

685-
<!-- Exclude site since it's not released -->
686-
<exclude>**/site/**</exclude>
697+
<!-- Exclude site files -->
698+
<exclude>site/Gemfile.lock</exclude>
699+
<exclude>site/VERSIONS</exclude>
700+
<exclude>site/_sass/bootstrap-sass/**</exclude>
701+
<exclude>site/_sass/font-awesome/**</exclude>
702+
<exclude>site/.sass-cache/**</exclude>
703+
<exclude>site/fonts/**</exclude>
704+
<exclude>site/img/**</exclude>
705+
<exclude>site/js/jquery.scrollTo.min.js</exclude>
706+
<exclude>site/js/jquery.tocify.min.js</exclude>
707+
<exclude>generated-site/**</exclude>
687708

688709
<exclude>**/*.patch</exclude>
689-
<exclude>**/*.md</exclude>
710+
<exclude>.github/*.md</exclude>
690711

691712
<exclude>src/assemble/LICENSE.bin.txt</exclude>
692713
<exclude>src/assemble/NOTICE.bin.txt</exclude>

‎protobuf/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
121

222
## Protocol Buffer code generation
323

‎pulsar-client-cpp/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
121

222
# Pulsar C++ client library
323
<!-- TOC depthFrom:2 depthTo:3 withLinks:1 updateOnSave:1 orderedList:0 -->

‎pulsar-client-cpp/docs/MainPage.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
122
# The Pulsar C++ client
223

324
Welcome to the Doxygen documentation for [Pulsar](https://pulsar.incubator.apache.org/).

‎pulsar-discovery-service/readme.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
122
# Discovery service
223

324
It keeps list of active available brokers and redirects all incoming requests to one of the broker in round-robin manner.

‎site/Gemfile

+19
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
#
2+
# Licensed to the Apache Software Foundation (ASF) under one
3+
# or more contributor license agreements. See the NOTICE file
4+
# distributed with this work for additional information
5+
# regarding copyright ownership. The ASF licenses this file
6+
# to you under the Apache License, Version 2.0 (the
7+
# "License"); you may not use this file except in compliance
8+
# with the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing,
13+
# software distributed under the License is distributed on an
14+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
# KIND, either express or implied. See the License for the
16+
# specific language governing permissions and limitations
17+
# under the License.
18+
#
19+
120
source 'https://rubygems.org'
221
ruby '2.4.1'
322

‎site/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
122
# The Pulsar website and documentation
223

324
This `README` is basically the meta-documentation for the Pulsar website and documentation. Here you'll find instructions on running the site locally

‎site/_includes/explanations/admin-setup.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
122
Each of Pulsar's three admin interfaces---the [`pulsar-admin`](../../reference/CliTools#pulsar-admin) CLI tool, the [Java admin API](/api/admin), and the [REST API](../../reference/RestApi)---requires some special setup if you have [authentication](../../admin/Authz#authentication-providers) enabled in your Pulsar {% popover instance %}.
223

324
### pulsar-admin

‎site/_includes/explanations/client-url.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,24 @@
1+
<!--
2+
3+
Licensed to the Apache Software Foundation (ASF) under one
4+
or more contributor license agreements. See the NOTICE file
5+
distributed with this work for additional information
6+
regarding copyright ownership. The ASF licenses this file
7+
to you under the Apache License, Version 2.0 (the
8+
"License"); you may not use this file except in compliance
9+
with the License. You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing,
14+
software distributed under the License is distributed on an
15+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
KIND, either express or implied. See the License for the
17+
specific language governing permissions and limitations
18+
under the License.
19+
20+
-->
21+
122
To connect to Pulsar using client libraries, you need to specify a [Pulsar protocol](../../project/BinaryProtocol) URL.
223

324
Pulsar protocol URLs are assigned to specific {% popover clusters %}, use the `pulsar` scheme and have a default port of 6650. Here's an example for `localhost`:
@@ -30,4 +51,4 @@ If the topic is global, however, the URL for the topic will look like this:
3051

3152
{% include topic.html p="property" c="global" n="namespace" t="topic" %}
3253

33-
In that case, your client can use the broker service URL for *any* cluster in the {% popover instance %} and Pulsar's internal service discovery system will handle the rest.
54+
In that case, your client can use the broker service URL for *any* cluster in the {% popover instance %} and Pulsar's internal service discovery system will handle the rest.

0 commit comments

Comments
 (0)