[PATCH 0/3] A couple of changes on the documentation main page

[PATCH 0/3] A couple of changes on the documentation main page

[Nicolas Dechesne]

A few simple changes to try to improve the content of the main page. I
am still hoping that we can have a more graphical main page
eventually. I really like
https://projectacrn.github.io/latest/index.html for example (also
managed with Sphinx)

Nicolas Dechesne (3):
  index: remove the link/section to 'mega manual' from main page
  index: remove links to releases manual and index
  index: split releases manuals and indexes into two section in the tree

 documentation/index.rst | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

-- 
2.31.1

[PATCH 1/3] index: remove the link/section to 'mega manual' from main page

[Nicolas Dechesne]

The 'megamanuel' can be selected using the drop down menu on the
documentation website. It was reported it is confusing to have it on
the main page (and in the left side bar) as well. Let's remove it.

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
---
 documentation/index.rst | 6 ------
 1 file changed, 6 deletions(-)

diff --git a/documentation/index.rst b/documentation/index.rst
index 6aeeb2197..7b70ebc02 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -36,12 +36,6 @@ Welcome to the Yocto Project Documentation
    Test Environment Manual <test-manual/index>
    bitbake
 
-.. toctree::
-   :maxdepth: 1
-   :caption: 'Mega' Manual
-
-   All-in-one 'Mega' Manual <https://docs.yoctoproject.org/singleindex.html>
-
 .. toctree::
    :maxdepth: 1
    :caption: Manuals/Variable Index
-- 
2.31.1

[PATCH 2/3] index: remove links to releases manual and index

[Nicolas Dechesne]

Keep the links in the left side navigation bar, but remove them from
the main page.

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
---
 documentation/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/documentation/index.rst b/documentation/index.rst
index 7b70ebc02..a0b652677 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -39,6 +39,7 @@ Welcome to the Yocto Project Documentation
 .. toctree::
    :maxdepth: 1
    :caption: Manuals/Variable Index
+   :hidden:
 
    genindex
    Current/Previous Version Specific Manuals <releases>
-- 
2.31.1

[PATCH 3/3] index: split releases manuals and indexes into two section in the tree

[Nicolas Dechesne]

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
---
 documentation/index.rst | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/documentation/index.rst b/documentation/index.rst
index a0b652677..ee9fe055a 100644
--- a/documentation/index.rst
+++ b/documentation/index.rst
@@ -38,11 +38,14 @@ Welcome to the Yocto Project Documentation
 
 .. toctree::
    :maxdepth: 1
-   :caption: Manuals/Variable Index
+   :caption: Releases manual
    :hidden:
 
-   genindex
-   Current/Previous Version Specific Manuals <releases>
-
+   releases
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Documentation Index
+   :hidden:
 
+   genindex
-- 
2.31.1

Re: [docs] [PATCH 0/3] A couple of changes on the documentation main page

[Quentin Schulz]

Hi Nicolas,

On Wed, May 26, 2021 at 02:22:47PM +0200, Nicolas Dechesne wrote:
> A few simple changes to try to improve the content of the main page. I
> am still hoping that we can have a more graphical main page
> eventually. I really like
> https://projectacrn.github.io/latest/index.html for example (also
> managed with Sphinx)
> 
> Nicolas Dechesne (3):
>   index: remove the link/section to 'mega manual' from main page
>   index: remove links to releases manual and index
>   index: split releases manuals and indexes into two section in the tree
> 

Reviewed-by: Quentin Schulz <foss@0leil.net>

Cheers,
Quentin

Re: [docs] [PATCH 0/3] A couple of changes on the documentation main page

[Michael Opdenacker]

On 5/27/21 2:55 PM, Quentin Schulz wrote:
> Reviewed-by: Quentin Schulz <foss@0leil.net>

Tested-by: Michael Opdenacker <michael.opdenacker@bootlin.com>


Merged into master-next. The changes definitely make sense and look
great. Thanks Nicolas!

Cheers,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

Re: [docs] [PATCH 1/3] index: remove the link/section to 'mega manual' from main page

[Michael Opdenacker]

Hi Nicolas,

On 5/26/21 2:22 PM, Nicolas Dechesne wrote:
> The 'megamanuel' can be selected using the drop down menu on the
> documentation website. It was reported it is confusing to have it on
> the main page (and in the left side bar) as well. Let's remove it.


I must confess I was a bit confused by this change first. I first
thought that the presence in the left bar would remain.

Habits are sticky. Let's see if people get used to this one.

Cheers,

Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com