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/11/01 07:22:55 UTC
Missing navigation to functions-api page
Starting at any point in the current documentation, e.g.
https://pulsar.apache.org/docs/en/next/functions-overview/
There is a hidden page "functions-api" which doesn't appear to be linked
from the navbar:
https://pulsar.apache.org/docs/en/next/functions-api/
And if you go to that page manually, it doesn't have a navbar of its own.
I have no idea how to fix, but thought I'd report it here.
Cheers,
Brian.
Re: Missing navigation to functions-api page
Posted by Jinfeng Huang <hj...@streamnative.io>.
Dear Brian,
Thank you very much for your question.
In 2.4.1, we've improved the structure and content of Pulsar Functions, you
can find the API related information at
https://pulsar.apache.org/docs/en/next/functions-develop/
I've removed Functions API from the navigation bar.
Best Regards,
Jennifer
On Fri, Nov 1, 2019 at 3:23 PM Brian Candler <b....@pobox.com> wrote:
> Starting at any point in the current documentation, e.g.
>
> https://pulsar.apache.org/docs/en/next/functions-overview/
>
> There is a hidden page "functions-api" which doesn't appear to be linked
> from the navbar:
>
> https://pulsar.apache.org/docs/en/next/functions-api/
>
> And if you go to that page manually, it doesn't have a navbar of its own.
>
> I have no idea how to fix, but thought I'd report it here.
>
> Cheers,
>
> Brian.
>
>
Re: Missing navigation to functions-api page
Posted by Jinfeng Huang <hj...@streamnative.io>.
Hi Brian,
Thanks very much for your feedback. In the origin `functions-state.md`
file, there are two paragraphs related to the `state storage`, and the rest
is more about APIs. Since I put all available APIs info into develop parts,
so I removed the `functions-state.md` file. If there no more information on
`state storage`, we can add those info in that section.
`functions-api.md` file should be removed from 2.4.1 version since it's not
in the sidebar.
I noticed that you have a PR https://github.com/apache/pulsar/pull/5531,
I'll review and leave comments in this PR.
Best Regards,
Jennifer
On Fri, Nov 1, 2019 at 4:52 PM Brian Candler <b....@pobox.com> wrote:
> On 01/11/2019 08:25, Jinfeng Huang wrote:
> > It's the same case for `state storage`, I've put the information
> > https://pulsar.apache.org/docs/en/next/functions-develop/#state-storage
>
> OK, but there's almost no information there at all - just two short
> paragraphs, no examples.
>
> I've already updated "functions-state" to include Python examples, but
> not pushed a PR yet.
>
> I'll do that shortly - then you can decide whether you want to merge
> this into functions-develop, in which case you can "git rm
> functions-state.md"
>
> Ditto for functions-api; if it's stale and unlinked, I think it should
> be "git rm'd".
>
> Cheers,
>
> Brian.
>
>
Re: Missing navigation to functions-api page
Posted by Brian Candler <b....@pobox.com>.
On 01/11/2019 08:25, Jinfeng Huang wrote:
> It's the same case for `state storage`, I've put the information
> https://pulsar.apache.org/docs/en/next/functions-develop/#state-storage
OK, but there's almost no information there at all - just two short
paragraphs, no examples.
I've already updated "functions-state" to include Python examples, but
not pushed a PR yet.
I'll do that shortly - then you can decide whether you want to merge
this into functions-develop, in which case you can "git rm
functions-state.md"
Ditto for functions-api; if it's stale and unlinked, I think it should
be "git rm'd".
Cheers,
Brian.
Re: Missing navigation to functions-api page
Posted by Jinfeng Huang <hj...@streamnative.io>.
It's the same case for `state storage`, I've put the information
https://pulsar.apache.org/docs/en/next/functions-develop/#state-storage
If you have any advice on the new structure, feel free to let us know.
Best Regards,
Jennifer
On Fri, Nov 1, 2019 at 4:03 PM Brian Candler <b....@pobox.com> wrote:
> On 01/11/2019 07:22, Brian Candler wrote:
> > Starting at any point in the current documentation, e.g.
> >
> > https://pulsar.apache.org/docs/en/next/functions-overview/
> >
> > There is a hidden page "functions-api" which doesn't appear to be
> > linked from the navbar:
>
> And I've also just discovered another unlinked page
>
> https://pulsar.apache.org/docs/en/next/functions-state/
>
> ... which might have saved me asking some questions here if I'd known
> about it :-)
>
>
Re: Missing navigation to functions-api page
Posted by Brian Candler <b....@pobox.com>.
On 01/11/2019 07:22, Brian Candler wrote:
> Starting at any point in the current documentation, e.g.
>
> https://pulsar.apache.org/docs/en/next/functions-overview/
>
> There is a hidden page "functions-api" which doesn't appear to be
> linked from the navbar:
And I've also just discovered another unlinked page
https://pulsar.apache.org/docs/en/next/functions-state/
... which might have saved me asking some questions here if I'd known
about it :-)