Camel component list on github

classic Classic list List threaded Threaded
7 messages Options
Reply | Threaded
Open this post in threaded view
|

Camel component list on github

Claus Ibsen-2
Hi

Before our new website, we were in a transition phase with the old
outdate wiki based website and then towards a new website. In that
phase we referred users to browse github directly for the up to date
documentation.

The component list at
https://github.com/apache/camel/blob/master/components/readme.adoc#components

Have direct links to each component docs in the source code with
relative folder paths.

However now that we have a new website, then I wonder if we should
discontinue the pages on github, to keep maintenance lower, and avoid
duplicated effort. We can refer users to the website.

We will continue to keep the component docs in the source code,
together with the component source, eg in the src/main/docs folder. As
we grab all of that when we build the website.

So its more about reducing the documentation navigation and relative
links we have on github vs the new website.





--
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2
Reply | Threaded
Open this post in threaded view
|

Re: Camel component list on github

Andrea Cosentino-3
+1, it's less effort in terms of maintaining.

Il giorno lun 14 ott 2019 alle ore 10:39 Claus Ibsen <[hidden email]>
ha scritto:

> Hi
>
> Before our new website, we were in a transition phase with the old
> outdate wiki based website and then towards a new website. In that
> phase we referred users to browse github directly for the up to date
> documentation.
>
> The component list at
>
> https://github.com/apache/camel/blob/master/components/readme.adoc#components
>
> Have direct links to each component docs in the source code with
> relative folder paths.
>
> However now that we have a new website, then I wonder if we should
> discontinue the pages on github, to keep maintenance lower, and avoid
> duplicated effort. We can refer users to the website.
>
> We will continue to keep the component docs in the source code,
> together with the component source, eg in the src/main/docs folder. As
> we grab all of that when we build the website.
>
> So its more about reducing the documentation navigation and relative
> links we have on github vs the new website.
>
>
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2
>
Reply | Threaded
Open this post in threaded view
|

Re: Camel component list on github

Alex Dettinger
+1, it may even be clearer to users to have the whole list in a singe place.

Alex

On Mon, Oct 14, 2019 at 10:41 AM Andrea Cosentino <[hidden email]> wrote:

> +1, it's less effort in terms of maintaining.
>
> Il giorno lun 14 ott 2019 alle ore 10:39 Claus Ibsen <
> [hidden email]>
> ha scritto:
>
> > Hi
> >
> > Before our new website, we were in a transition phase with the old
> > outdate wiki based website and then towards a new website. In that
> > phase we referred users to browse github directly for the up to date
> > documentation.
> >
> > The component list at
> >
> >
> https://github.com/apache/camel/blob/master/components/readme.adoc#components
> >
> > Have direct links to each component docs in the source code with
> > relative folder paths.
> >
> > However now that we have a new website, then I wonder if we should
> > discontinue the pages on github, to keep maintenance lower, and avoid
> > duplicated effort. We can refer users to the website.
> >
> > We will continue to keep the component docs in the source code,
> > together with the component source, eg in the src/main/docs folder. As
> > we grab all of that when we build the website.
> >
> > So its more about reducing the documentation navigation and relative
> > links we have on github vs the new website.
> >
> >
> >
> >
> >
> > --
> > Claus Ibsen
> > -----------------
> > http://davsclaus.com @davsclaus
> > Camel in Action 2: https://www.manning.com/ibsen2
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Camel component list on github

omarsmak
+1 as long less effort has been made

On Mon, 14 Oct 2019 at 11:02, Alex Dettinger <[hidden email]> wrote:

> +1, it may even be clearer to users to have the whole list in a singe
> place.
>
> Alex
>
> On Mon, Oct 14, 2019 at 10:41 AM Andrea Cosentino <[hidden email]>
> wrote:
>
> > +1, it's less effort in terms of maintaining.
> >
> > Il giorno lun 14 ott 2019 alle ore 10:39 Claus Ibsen <
> > [hidden email]>
> > ha scritto:
> >
> > > Hi
> > >
> > > Before our new website, we were in a transition phase with the old
> > > outdate wiki based website and then towards a new website. In that
> > > phase we referred users to browse github directly for the up to date
> > > documentation.
> > >
> > > The component list at
> > >
> > >
> >
> https://github.com/apache/camel/blob/master/components/readme.adoc#components
> > >
> > > Have direct links to each component docs in the source code with
> > > relative folder paths.
> > >
> > > However now that we have a new website, then I wonder if we should
> > > discontinue the pages on github, to keep maintenance lower, and avoid
> > > duplicated effort. We can refer users to the website.
> > >
> > > We will continue to keep the component docs in the source code,
> > > together with the component source, eg in the src/main/docs folder. As
> > > we grab all of that when we build the website.
> > >
> > > So its more about reducing the documentation navigation and relative
> > > links we have on github vs the new website.
> > >
> > >
> > >
> > >
> > >
> > > --
> > > Claus Ibsen
> > > -----------------
> > > http://davsclaus.com @davsclaus
> > > Camel in Action 2: https://www.manning.com/ibsen2
> > >
> >
>
Reply | Threaded
Open this post in threaded view
|

Re: Camel component list on github

Zoran Regvart-2
In reply to this post by Claus Ibsen-2
+1 I think this should require less regen commits...

zoran

On Mon, Oct 14, 2019 at 10:39 AM Claus Ibsen <[hidden email]> wrote:

>
> Hi
>
> Before our new website, we were in a transition phase with the old
> outdate wiki based website and then towards a new website. In that
> phase we referred users to browse github directly for the up to date
> documentation.
>
> The component list at
> https://github.com/apache/camel/blob/master/components/readme.adoc#components
>
> Have direct links to each component docs in the source code with
> relative folder paths.
>
> However now that we have a new website, then I wonder if we should
> discontinue the pages on github, to keep maintenance lower, and avoid
> duplicated effort. We can refer users to the website.
>
> We will continue to keep the component docs in the source code,
> together with the component source, eg in the src/main/docs folder. As
> we grab all of that when we build the website.
>
> So its more about reducing the documentation navigation and relative
> links we have on github vs the new website.
>
>
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2



--
Zoran Regvart
Reply | Threaded
Open this post in threaded view
|

Re: Camel component list on github

Claus Ibsen-2
In reply to this post by Claus Ibsen-2
Hi

Okay I created a Jira to not forget
https://issues.apache.org/jira/browse/CAMEL-14065

On Mon, Oct 14, 2019 at 10:38 AM Claus Ibsen <[hidden email]> wrote:

>
> Hi
>
> Before our new website, we were in a transition phase with the old
> outdate wiki based website and then towards a new website. In that
> phase we referred users to browse github directly for the up to date
> documentation.
>
> The component list at
> https://github.com/apache/camel/blob/master/components/readme.adoc#components
>
> Have direct links to each component docs in the source code with
> relative folder paths.
>
> However now that we have a new website, then I wonder if we should
> discontinue the pages on github, to keep maintenance lower, and avoid
> duplicated effort. We can refer users to the website.
>
> We will continue to keep the component docs in the source code,
> together with the component source, eg in the src/main/docs folder. As
> we grab all of that when we build the website.
>
> So its more about reducing the documentation navigation and relative
> links we have on github vs the new website.
>
>
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2



--
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2
Reply | Threaded
Open this post in threaded view
|

Re: Camel component list on github

Claus Ibsen-2
Hi

Okay so I have just implemented this and pushed to master. The readme
file in components is now gone.

On Mon, Oct 14, 2019 at 9:18 PM Claus Ibsen <[hidden email]> wrote:

>
> Hi
>
> Okay I created a Jira to not forget
> https://issues.apache.org/jira/browse/CAMEL-14065
>
> On Mon, Oct 14, 2019 at 10:38 AM Claus Ibsen <[hidden email]> wrote:
> >
> > Hi
> >
> > Before our new website, we were in a transition phase with the old
> > outdate wiki based website and then towards a new website. In that
> > phase we referred users to browse github directly for the up to date
> > documentation.
> >
> > The component list at
> > https://github.com/apache/camel/blob/master/components/readme.adoc#components
> >
> > Have direct links to each component docs in the source code with
> > relative folder paths.
> >
> > However now that we have a new website, then I wonder if we should
> > discontinue the pages on github, to keep maintenance lower, and avoid
> > duplicated effort. We can refer users to the website.
> >
> > We will continue to keep the component docs in the source code,
> > together with the component source, eg in the src/main/docs folder. As
> > we grab all of that when we build the website.
> >
> > So its more about reducing the documentation navigation and relative
> > links we have on github vs the new website.
> >
> >
> >
> >
> >
> > --
> > Claus Ibsen
> > -----------------
> > http://davsclaus.com @davsclaus
> > Camel in Action 2: https://www.manning.com/ibsen2
>
>
>
> --
> Claus Ibsen
> -----------------
> http://davsclaus.com @davsclaus
> Camel in Action 2: https://www.manning.com/ibsen2



--
Claus Ibsen
-----------------
http://davsclaus.com @davsclaus
Camel in Action 2: https://www.manning.com/ibsen2