Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Brian Bouterse]

On Thu, Oct 1, 2020 at 10:05 AM Quirin Pamp  wrote:

> Of course these options are not mutually exclusive. We could decide on
> some theme (e.g.: pulp_ansible theme) and then have both pulpcore and all
> plugins consistently use that theme.
> I do quite like the sphinx_rtd_theme used by pulpcore, but that may just
> be because I am used to it.
>
> I guess my personal preferences would be:
>
> 1) All plugins and pulpcore use a custom pulp theme with pulp logo and a
> colour scheme like the one on https://pulpproject.org/
> 2) All plugins and pulpcore simply use the sphinx_rtd_theme (which strikes
> me as good enough, already widely in use, and similar to what readthedocs
> uses, so nobody needs to get used to anything totally new).
> 3) All plugins and pulpcore consistently use some other agreed upon theme.
>
> In the interest of "getting on with it" I would propose going with option
> (2) right now, and setting option (1) as a long term goal (perhaps open an
> issue for it).
>
This all sounds good to me.


> Kind regards,
> Quirin Pamp (quba42)
>
> --
> *From:* Ina Panova 
> *Sent:* 01 October 2020 15:00
> *To:* Dennis Kliban 
> *Cc:* Quirin Pamp ; Pulp-dev 
> *Subject:* Re: [Pulp-dev] sphinx theme for docs.pulpproject.org
>
> my preference number 1 would be making plugins consistent with pulpcore.
> 2nd preference would be plup_ansibe theme.
>
> 
> Regards,
>
> Ina Panova
> Senior Software Engineer| Pulp| Red Hat Inc.
>
> "Do not go where the path may lead,
>  go instead where there is no path and leave a trail."
>
>
> On Thu, Sep 24, 2020 at 4:14 PM Dennis Kliban  wrote:
>
> On Thu, Sep 24, 2020 at 9:01 AM Quirin Pamp  wrote:
>
> I don't have a strong opinion, but I feel like if we don't come up with
> anything better we could just  fall back to what the pulpcore docs are
> currently using.
>
> https://docs.pulpproject.org/pulpcore/
>
> https://github.com/pulp/pulpcore/blob/d31eb22453cd2d56b43ed884ec193fa166cafe62/docs/conf.py#L116
>
>
> +1 to making everything consistent with pulpcore.
>
>
> quba42
> --
> *From:* pulp-dev-boun...@redhat.com  on
> behalf of Dennis Kliban 
> *Sent:* 24 September 2020 14:47
> *To:* Pulp-dev 
> *Subject:* [Pulp-dev] sphinx theme for docs.pulpproject.org
>
> We are slowly rolling out plugin docs to docs.pulpproject.org. At this
> time pulp_file and pulp_ansible are the only plugins publishing their docs
> there. What I noticed is that they have completely different themes. We
> need to pick a single theme to be used by all plugins. Does anyone have
> suggestions for which theme that should be?
>
> https://docs.pulpproject.org/pulp_ansible/
> https://docs.pulpproject.org/pulp_file/
>
> ___
> Pulp-dev mailing list
> Pulp-dev@redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev
>
> ___
> Pulp-dev mailing list
> Pulp-dev@redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev
>
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Quirin Pamp]

Of course these options are not mutually exclusive. We could decide on some 
theme (e.g.: pulp_ansible theme) and then have both pulpcore and all plugins 
consistently use that theme.
I do quite like the sphinx_rtd_theme used by pulpcore, but that may just be 
because I am used to it.

I guess my personal preferences would be:

1) All plugins and pulpcore use a custom pulp theme with pulp logo and a colour 
scheme like the one on https://pulpproject.org/
2) All plugins and pulpcore simply use the sphinx_rtd_theme (which strikes me 
as good enough, already widely in use, and similar to what readthedocs uses, so 
nobody needs to get used to anything totally new).
3) All plugins and pulpcore consistently use some other agreed upon theme.

In the interest of "getting on with it" I would propose going with option (2) 
right now, and setting option (1) as a long term goal (perhaps open an issue 
for it).

Kind regards,
Quirin Pamp (quba42)


From: Ina Panova 
Sent: 01 October 2020 15:00
To: Dennis Kliban 
Cc: Quirin Pamp ; Pulp-dev 
Subject: Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

my preference number 1 would be making plugins consistent with pulpcore.
2nd preference would be plup_ansibe theme.


Regards,

Ina Panova
Senior Software Engineer| Pulp| Red Hat Inc.

"Do not go where the path may lead,
 go instead where there is no path and leave a trail."


On Thu, Sep 24, 2020 at 4:14 PM Dennis Kliban 
mailto:dkli...@redhat.com>> wrote:
On Thu, Sep 24, 2020 at 9:01 AM Quirin Pamp mailto:p...@atix.de>> 
wrote:
I don't have a strong opinion, but I feel like if we don't come up with 
anything better we could just  fall back to what the pulpcore docs are 
currently using.

https://docs.pulpproject.org/pulpcore/
https://github.com/pulp/pulpcore/blob/d31eb22453cd2d56b43ed884ec193fa166cafe62/docs/conf.py#L116


+1 to making everything consistent with pulpcore.

quba42

From: pulp-dev-boun...@redhat.com<mailto:pulp-dev-boun...@redhat.com> 
mailto:pulp-dev-boun...@redhat.com>> on behalf of 
Dennis Kliban mailto:dkli...@redhat.com>>
Sent: 24 September 2020 14:47
To: Pulp-dev mailto:pulp-dev@redhat.com>>
Subject: [Pulp-dev] sphinx theme for 
docs.pulpproject.org<http://docs.pulpproject.org>

We are slowly rolling out plugin docs to 
docs.pulpproject.org<http://docs.pulpproject.org>. At this time pulp_file and 
pulp_ansible are the only plugins publishing their docs there. What I noticed 
is that they have completely different themes. We need to pick a single theme 
to be used by all plugins. Does anyone have suggestions for which theme that 
should be?

https://docs.pulpproject.org/pulp_ansible/
https://docs.pulpproject.org/pulp_file/
___
Pulp-dev mailing list
Pulp-dev@redhat.com<mailto:Pulp-dev@redhat.com>
https://www.redhat.com/mailman/listinfo/pulp-dev
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Ina Panova]

my preference number 1 would be making plugins consistent with pulpcore.
2nd preference would be plup_ansibe theme.


Regards,

Ina Panova
Senior Software Engineer| Pulp| Red Hat Inc.

"Do not go where the path may lead,
 go instead where there is no path and leave a trail."


On Thu, Sep 24, 2020 at 4:14 PM Dennis Kliban  wrote:

> On Thu, Sep 24, 2020 at 9:01 AM Quirin Pamp  wrote:
>
>> I don't have a strong opinion, but I feel like if we don't come up with
>> anything better we could just  fall back to what the pulpcore docs are
>> currently using.
>>
>> https://docs.pulpproject.org/pulpcore/
>>
>> https://github.com/pulp/pulpcore/blob/d31eb22453cd2d56b43ed884ec193fa166cafe62/docs/conf.py#L116
>>
>>
> +1 to making everything consistent with pulpcore.
>
>
>> quba42
>> --
>> *From:* pulp-dev-boun...@redhat.com  on
>> behalf of Dennis Kliban 
>> *Sent:* 24 September 2020 14:47
>> *To:* Pulp-dev 
>> *Subject:* [Pulp-dev] sphinx theme for docs.pulpproject.org
>>
>> We are slowly rolling out plugin docs to docs.pulpproject.org. At this
>> time pulp_file and pulp_ansible are the only plugins publishing their docs
>> there. What I noticed is that they have completely different themes. We
>> need to pick a single theme to be used by all plugins. Does anyone have
>> suggestions for which theme that should be?
>>
>> https://docs.pulpproject.org/pulp_ansible/
>> https://docs.pulpproject.org/pulp_file/
>>
> ___
> Pulp-dev mailing list
> Pulp-dev@redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev
>
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Dennis Kliban]

Looks like dynaconf is no longer using Sphinx for the docs. Unfortunately
that is not an option for us at this time.

On Thu, Sep 24, 2020 at 8:57 AM Fabricio Aguiar 
wrote:

> I like the new dynaconf theme: https://www.dynaconf.com/
>
> Best regards,
> Fabricio Aguiar
> Software Engineer, Pulp Project
> Red Hat Brazil - Latam 
> +55 11 999652368
>
>
> On Thu, Sep 24, 2020 at 9:48 AM Dennis Kliban  wrote:
>
>> We are slowly rolling out plugin docs to docs.pulpproject.org. At this
>> time pulp_file and pulp_ansible are the only plugins publishing their docs
>> there. What I noticed is that they have completely different themes. We
>> need to pick a single theme to be used by all plugins. Does anyone have
>> suggestions for which theme that should be?
>>
>> https://docs.pulpproject.org/pulp_ansible/
>> https://docs.pulpproject.org/pulp_file/
>> ___
>> Pulp-dev mailing list
>> Pulp-dev@redhat.com
>> https://www.redhat.com/mailman/listinfo/pulp-dev
>>
>
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Melanie Corr]

Ar Déar 24 MFómh 2020 ag 15:03, scríobh Dennis Kliban :

>
> On Thu, Sep 24, 2020 at 8:59 AM Melanie Corr  wrote:
>
>> Hi Dennis,
>>
>> This reminds me that Pulp got feedback related to the difference in style
>> between the main website and the docs from the OSPO audit last year:
>>
>> "● Create consistent styles between main and docs domain"
>>
>> Would this be hard to achieve?
>>
>
> We would need to find a Jekyll theme (pulpproject.org) that is paired
> with a Sphinx theme (docs.pulpproject.org). This would most likely
> require us creating something custom for both. Seems like a big effort.
>
>

I don't think that the result would justify the effort.
Thanks, Dennis.
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Dennis Kliban]

On Thu, Sep 24, 2020 at 9:01 AM Quirin Pamp  wrote:

> I don't have a strong opinion, but I feel like if we don't come up with
> anything better we could just  fall back to what the pulpcore docs are
> currently using.
>
> https://docs.pulpproject.org/pulpcore/
>
> https://github.com/pulp/pulpcore/blob/d31eb22453cd2d56b43ed884ec193fa166cafe62/docs/conf.py#L116
>
>
+1 to making everything consistent with pulpcore.


> quba42
> --
> *From:* pulp-dev-boun...@redhat.com  on
> behalf of Dennis Kliban 
> *Sent:* 24 September 2020 14:47
> *To:* Pulp-dev 
> *Subject:* [Pulp-dev] sphinx theme for docs.pulpproject.org
>
> We are slowly rolling out plugin docs to docs.pulpproject.org. At this
> time pulp_file and pulp_ansible are the only plugins publishing their docs
> there. What I noticed is that they have completely different themes. We
> need to pick a single theme to be used by all plugins. Does anyone have
> suggestions for which theme that should be?
>
> https://docs.pulpproject.org/pulp_ansible/
> https://docs.pulpproject.org/pulp_file/
>
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Dennis Kliban]

On Thu, Sep 24, 2020 at 8:59 AM Melanie Corr  wrote:

> Hi Dennis,
>
> This reminds me that Pulp got feedback related to the difference in style
> between the main website and the docs from the OSPO audit last year:
>
> "● Create consistent styles between main and docs domain"
>
> Would this be hard to achieve?
>

We would need to find a Jekyll theme (pulpproject.org) that is paired with
a Sphinx theme (docs.pulpproject.org). This would most likely require us
creating something custom for both. Seems like a big effort.


>
> Ar Déar 24 MFómh 2020 ag 13:48, scríobh Dennis Kliban  >:
>
>> We are slowly rolling out plugin docs to docs.pulpproject.org. At this
>> time pulp_file and pulp_ansible are the only plugins publishing their docs
>> there. What I noticed is that they have completely different themes. We
>> need to pick a single theme to be used by all plugins. Does anyone have
>> suggestions for which theme that should be?
>>
>> https://docs.pulpproject.org/pulp_ansible/
>> https://docs.pulpproject.org/pulp_file/
>> ___
>> Pulp-dev mailing list
>> Pulp-dev@redhat.com
>> https://www.redhat.com/mailman/listinfo/pulp-dev
>>
>
>
> --
>
> Melanie Corr, RHCE
>
> Community Manager
>
> Red Hat 
>
> Remote, Ireland
>
> mc...@redhat.com
> M: +353857774436 IM: mcorr
> 
>
>
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Quirin Pamp]

I don't have a strong opinion, but I feel like if we don't come up with 
anything better we could just  fall back to what the pulpcore docs are 
currently using.

https://docs.pulpproject.org/pulpcore/
https://github.com/pulp/pulpcore/blob/d31eb22453cd2d56b43ed884ec193fa166cafe62/docs/conf.py#L116

quba42

From: pulp-dev-boun...@redhat.com  on behalf of 
Dennis Kliban 
Sent: 24 September 2020 14:47
To: Pulp-dev 
Subject: [Pulp-dev] sphinx theme for docs.pulpproject.org

We are slowly rolling out plugin docs to 
docs.pulpproject.org<http://docs.pulpproject.org>. At this time pulp_file and 
pulp_ansible are the only plugins publishing their docs there. What I noticed 
is that they have completely different themes. We need to pick a single theme 
to be used by all plugins. Does anyone have suggestions for which theme that 
should be?

https://docs.pulpproject.org/pulp_ansible/
https://docs.pulpproject.org/pulp_file/
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Matthias Dellweg]

I like the one used by ansible more, but is desperately lacking a big pulp
logo.
Would it be feasible to have a theme that looks like
https://pulpproject.org/ ?

On Thu, Sep 24, 2020 at 2:48 PM Dennis Kliban  wrote:

> We are slowly rolling out plugin docs to docs.pulpproject.org. At this
> time pulp_file and pulp_ansible are the only plugins publishing their docs
> there. What I noticed is that they have completely different themes. We
> need to pick a single theme to be used by all plugins. Does anyone have
> suggestions for which theme that should be?
>
> https://docs.pulpproject.org/pulp_ansible/
> https://docs.pulpproject.org/pulp_file/
> ___
> Pulp-dev mailing list
> Pulp-dev@redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev
>
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

Re: [Pulp-dev] sphinx theme for docs.pulpproject.org

[Fabricio Aguiar]

I like the new dynaconf theme: https://www.dynaconf.com/

Best regards,
Fabricio Aguiar
Software Engineer, Pulp Project
Red Hat Brazil - Latam 
+55 11 999652368


On Thu, Sep 24, 2020 at 9:48 AM Dennis Kliban  wrote:

> We are slowly rolling out plugin docs to docs.pulpproject.org. At this
> time pulp_file and pulp_ansible are the only plugins publishing their docs
> there. What I noticed is that they have completely different themes. We
> need to pick a single theme to be used by all plugins. Does anyone have
> suggestions for which theme that should be?
>
> https://docs.pulpproject.org/pulp_ansible/
> https://docs.pulpproject.org/pulp_file/
> ___
> Pulp-dev mailing list
> Pulp-dev@redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev
>
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev

[Pulp-dev] sphinx theme for docs.pulpproject.org

[Dennis Kliban]

We are slowly rolling out plugin docs to docs.pulpproject.org. At this time
pulp_file and pulp_ansible are the only plugins publishing their docs
there. What I noticed is that they have completely different themes. We
need to pick a single theme to be used by all plugins. Does anyone have
suggestions for which theme that should be?

https://docs.pulpproject.org/pulp_ansible/
https://docs.pulpproject.org/pulp_file/
___
Pulp-dev mailing list
Pulp-dev@redhat.com
https://www.redhat.com/mailman/listinfo/pulp-dev