You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@pulsar.apache.org by Brian Candler <b....@pobox.com> on 2019/10/09 09:37:00 UTC
Broken links to IO connectors, and other website issues
I'd like to point out an issue with the documentation website.
At http://pulsar.apache.org/docs/en/io-connectors/ almost all of the
links to IO connectors are broken. For example, the link for
Elasticsearch sink points to
http://pulsar.apache.org/docs/en/io-connectors/io-elasticsearch.md#sink
which gives a 404 Not Found.
Looking in the source repo, the documentation is here:
https://github.com/apache/pulsar/blob/master/site2/docs/io-elasticsearch-sink.md
However I can't find the corresponding page in the published website.
For example,
http://pulsar.apache.org/docs/en/io-elasticsearch-sink/
does not work either.
Regards,
Brian.
P.S. A few other doc problems:
- in the navbar on the left, says "Persmissions" instead of "Permissions"
- I came across other broken links, e.g. on
http://pulsar.apache.org/docs/en/deploy-bare-metal/ it says:
Since Pulsar 2.1.0 release, Pulsar introducesstateful function
<http://pulsar.apache.org/docs/en/deploy-bare-metal/functions-state.md>for
Pulsar Functions.
"stateful function" links to
http://pulsar.apache.org/docs/en/deploy-bare-metal/functions-state.md
which does not exist. I couldn't find it in the main site, although I
found an old version at
http://pulsar.apache.org/docs/en/2.1.0-incubating/functions-state/
In general I think it would be a good idea to run Linkchecker
<https://wummel.github.io/linkchecker/> - it finds quite a large number
of 404s, which I won't list here:
$ linkchecker --ignore-url='/2.*' http://pulsar.apache.org/docs/en/
- There is contradictory information at
http://pulsar.apache.org/docs/en/concepts-architecture-overview/#apache-bookkeeper
as to whether Pulsar does or does not support non-persistent message stores.
-----
At the moment, Pulsar only supports persistent message storage. This
accounts for the|persistent|in all topic names. Here's an example:
|persistent://my-tenant/my-namespace/my-topic |
*Copy*
Pulsar also supports ephemeral (non-persistent
<http://pulsar.apache.org/docs/en/concepts-messaging#non-persistent-topics>)
message storage.
-----
- There is contradictory information about what versions of python are
supported. At http://pulsar.apache.org/docs/en/client-libraries-python/
it says that versions 3.4-3.7 are supported, but there is a link to
http://pulsar.apache.org/api/python/ where it says that only version 2.7
is supported.
Re: Broken links to IO connectors, and other website issues
Posted by Brian Candler <b....@pobox.com>.
On 09/10/2019 15:04, anonymitaet _ wrote:
> I’m afraid you do not open the correct (latest) doc website
> (https://pulsar.apache.org/docs/en/next/io-connectors/), where all the
> connector links work well
Ah OK. I was reading what I thought was the "current" documentation: go
to https://pulsar.apache.org <https://pulsar.apache.org/>, click on
"Docs" button.
Regards,
Brian.
Re: Broken links to IO connectors, and other website issues
Posted by anonymitaet _ <an...@hotmail.com>.
Hi Brian,
Thanks for your questions.
# connector link
1. I’m afraid you do not open the correct (latest) doc website (https://pulsar.apache.org/docs/en/next/io-connectors/), where all the connector links work well (except 3-4 does not work because some PRs have not been merged yet, those links will work once the PRs are merged, I’ll keep you updated).
1. Elastics search sink connector: https://pulsar.apache.org/docs/en/next/io-elasticsearch-sink/.
# doc issue
I’ve reported a doc issue (https://github.com/apache/pulsar/issues/5345) and will fix them.
Once the issue is fixed, I’ll keep you updated as well.
Feel free to ping me if you have more questions.
From: Brian Candler <b....@pobox.com>
Reply-To: "users@pulsar.apache.org" <us...@pulsar.apache.org>
Date: Wednesday, October 9, 2019 at 17:37
To: "users@pulsar.apache.org" <us...@pulsar.apache.org>
Subject: Broken links to IO connectors, and other website issues
I'd like to point out an issue with the documentation website.
At http://pulsar.apache.org/docs/en/io-connectors/ almost all of the links to IO connectors are broken. For example, the link for Elasticsearch sink points to
http://pulsar.apache.org/docs/en/io-connectors/io-elasticsearch.md#sink
which gives a 404 Not Found.
Looking in the source repo, the documentation is here: https://github.com/apache/pulsar/blob/master/site2/docs/io-elasticsearch-sink.md
However I can't find the corresponding page in the published website. For example,
http://pulsar.apache.org/docs/en/io-elasticsearch-sink/
does not work either.
Regards,
Brian.
P.S. A few other doc problems:
- in the navbar on the left, says "Persmissions" instead of "Permissions"
- I came across other broken links, e.g. on http://pulsar.apache.org/docs/en/deploy-bare-metal/ it says:
Since Pulsar 2.1.0 release, Pulsar introduces stateful function<http://pulsar.apache.org/docs/en/deploy-bare-metal/functions-state.md> for Pulsar Functions.
"stateful function" links to http://pulsar.apache.org/docs/en/deploy-bare-metal/functions-state.md which does not exist. I couldn't find it in the main site, although I found an old version at http://pulsar.apache.org/docs/en/2.1.0-incubating/functions-state/
In general I think it would be a good idea to run Linkchecker<https://wummel.github.io/linkchecker/> - it finds quite a large number of 404s, which I won't list here:
$ linkchecker --ignore-url='/2.*' http://pulsar.apache.org/docs/en/
- There is contradictory information at http://pulsar.apache.org/docs/en/concepts-architecture-overview/#apache-bookkeeper as to whether Pulsar does or does not support non-persistent message stores.
-----
At the moment, Pulsar only supports persistent message storage. This accounts for the persistent in all topic names. Here's an example:
persistent://my-tenant/my-namespace/my-topic
Copy
Pulsar also supports ephemeral (non-persistent<http://pulsar.apache.org/docs/en/concepts-messaging#non-persistent-topics>) message storage.
-----
- There is contradictory information about what versions of python are supported. At http://pulsar.apache.org/docs/en/client-libraries-python/ it says that versions 3.4-3.7 are supported, but there is a link to http://pulsar.apache.org/api/python/ where it says that only version 2.7 is supported.
Re: Broken links to IO connectors, and other website issues
Posted by Jinfeng Huang <hj...@streamnative.io>.
Hi Brian,
Thank you very much for your feedback. We'll look into the issue (
https://github.com/apache/pulsar/issues/5368) and fix it soon.
Best Regards,
Jennifer
On Fri, Oct 11, 2019 at 7:20 PM Brian Candler <b....@pobox.com> wrote:
> On 09/10/2019 10:37, Brian Candler wrote:
> >
> > - There is contradictory information about what versions of python are
> > supported. At
> > http://pulsar.apache.org/docs/en/client-libraries-python/ it says that
> > versions 3.4-3.7 are supported, but there is a link to
> > http://pulsar.apache.org/api/python/ where it says that only version
> > 2.7 is supported.
> >
> Looking into this further, I think it's simply that
> http://pulsar.apache.org/api/python/ is out-of-date and needs
> regenerating.
>
> As well as python3 now being supported, there is other new functionality
> which is not shown: e.g.
>
> - Client.create_producer and Client.create_reader can take a "schema"
> argument
> - Message.value() contains the object deserialized via schema
>
> Regards,
>
> Brian.
>
>
Re: Broken links to IO connectors, and other website issues
Posted by Brian Candler <b....@pobox.com>.
On 09/10/2019 10:37, Brian Candler wrote:
>
> - There is contradictory information about what versions of python are
> supported. At
> http://pulsar.apache.org/docs/en/client-libraries-python/ it says that
> versions 3.4-3.7 are supported, but there is a link to
> http://pulsar.apache.org/api/python/ where it says that only version
> 2.7 is supported.
>
Looking into this further, I think it's simply that
http://pulsar.apache.org/api/python/ is out-of-date and needs regenerating.
As well as python3 now being supported, there is other new functionality
which is not shown: e.g.
- Client.create_producer and Client.create_reader can take a "schema"
argument
- Message.value() contains the object deserialized via schema
Regards,
Brian.
Re: Broken links to IO connectors, and other website issues
Posted by Sijie Guo <gu...@gmail.com>.
Brian,
Thank you for reporting. I think it is probably related to the recent
documentation change in master.
We will be looking into it.
- Sijie
On Wed, Oct 9, 2019 at 11:37 AM Brian Candler <b....@pobox.com> wrote:
> I'd like to point out an issue with the documentation website.
>
> At http://pulsar.apache.org/docs/en/io-connectors/ almost all of the
> links to IO connectors are broken. For example, the link for Elasticsearch
> sink points to
>
> http://pulsar.apache.org/docs/en/io-connectors/io-elasticsearch.md#sink
>
> which gives a 404 Not Found.
>
> Looking in the source repo, the documentation is here:
> https://github.com/apache/pulsar/blob/master/site2/docs/io-elasticsearch-sink.md
>
> However I can't find the corresponding page in the published website. For
> example,
>
> http://pulsar.apache.org/docs/en/io-elasticsearch-sink/
>
> does not work either.
>
> Regards,
>
> Brian.
>
> P.S. A few other doc problems:
>
> - in the navbar on the left, says "Persmissions" instead of "Permissions"
>
> - I came across other broken links, e.g. on
> http://pulsar.apache.org/docs/en/deploy-bare-metal/ it says:
>
> Since Pulsar 2.1.0 release, Pulsar introduces stateful function
> <http://pulsar.apache.org/docs/en/deploy-bare-metal/functions-state.md> for
> Pulsar Functions.
>
> "stateful function" links to
> http://pulsar.apache.org/docs/en/deploy-bare-metal/functions-state.md
> which does not exist. I couldn't find it in the main site, although I
> found an old version at
> http://pulsar.apache.org/docs/en/2.1.0-incubating/functions-state/
>
> In general I think it would be a good idea to run Linkchecker
> <https://wummel.github.io/linkchecker/> - it finds quite a large number
> of 404s, which I won't list here:
>
> $ linkchecker --ignore-url='/2.*' http://pulsar.apache.org/docs/en/
>
> - There is contradictory information at
> http://pulsar.apache.org/docs/en/concepts-architecture-overview/#apache-bookkeeper
> as to whether Pulsar does or does not support non-persistent message stores.
>
> -----
>
> At the moment, Pulsar only supports persistent message storage. This
> accounts for the persistent in all topic names. Here's an example:
>
> persistent://my-tenant/my-namespace/my-topic
> *Copy*
>
> Pulsar also supports ephemeral (non-persistent
> <http://pulsar.apache.org/docs/en/concepts-messaging#non-persistent-topics>)
> message storage.
>
> -----
>
> - There is contradictory information about what versions of python are
> supported. At http://pulsar.apache.org/docs/en/client-libraries-python/
> it says that versions 3.4-3.7 are supported, but there is a link to
> http://pulsar.apache.org/api/python/ where it says that only version 2.7
> is supported.
>
>
>