* [PATCH 0/1] Update documentation URL @ 2021-03-19 18:13 Michael Opdenacker 2021-03-19 18:13 ` [PATCH 1/1] " Michael Opdenacker 0 siblings, 1 reply; 6+ messages in thread From: Michael Opdenacker @ 2021-03-19 18:13 UTC (permalink / raw) To: docs This patch looks trivial, but the change to documentation/brief-yoctoprojectqs/index.rst anticipates that my patches, to change the welcome message when you don't have any conf/local.conf file yet, have been accepted. You may prefer to wait for such patches to be merged before merging this one, just to make sure that the documentation is consistent with the command output. ^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH 1/1] Update documentation URL 2021-03-19 18:13 [PATCH 0/1] Update documentation URL Michael Opdenacker @ 2021-03-19 18:13 ` Michael Opdenacker 2021-03-20 11:16 ` [docs] " Quentin Schulz 0 siblings, 1 reply; 6+ messages in thread From: Michael Opdenacker @ 2021-03-19 18:13 UTC (permalink / raw) To: docs; +Cc: Michael Opdenacker Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> --- README | 2 +- documentation/brief-yoctoprojectqs/index.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README b/README index bab81057f..b3836baba 100644 --- a/README +++ b/README @@ -5,7 +5,7 @@ This repository contains documentation materials for a variety of the Yocto Project components. In particular see the README under documentation/. An online version of the documentation can be found at: - http://yoctoproject.org/documentation + https://docs.yoctoproject.org Where to Send Patches ===================== diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 63083cb13..11d8766ab 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -189,7 +189,7 @@ an entire Linux distribution, including the toolchain, from source. The Yocto Project has extensive documentation about OE including a reference manual which can be found at: - http://yoctoproject.org/documentation + https://docs.yoctoproject.org For more information about OpenEmbedded see their website: http://www.openembedded.org/ -- 2.25.1 ^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [docs] [PATCH 1/1] Update documentation URL 2021-03-19 18:13 ` [PATCH 1/1] " Michael Opdenacker @ 2021-03-20 11:16 ` Quentin Schulz 2021-03-22 14:46 ` Michael Opdenacker 0 siblings, 1 reply; 6+ messages in thread From: Quentin Schulz @ 2021-03-20 11:16 UTC (permalink / raw) To: docs, Michael Opdenacker Hi Michael, On March 19, 2021 6:13:22 PM UTC, Michael Opdenacker <michael.opdenacker@bootlin.com> wrote: >Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> >--- > README | 2 +- > documentation/brief-yoctoprojectqs/index.rst | 2 +- > 2 files changed, 2 insertions(+), 2 deletions(-) > >diff --git a/README b/README >index bab81057f..b3836baba 100644 >--- a/README >+++ b/README >@@ -5,7 +5,7 @@ This repository contains documentation materials for a variety of the Yocto > Project components. In particular see the README under documentation/. > > An online version of the documentation can be found at: >- http://yoctoproject.org/documentation >+ https://docs.yoctoproject.org > > Where to Send Patches > ===================== >diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst >index 63083cb13..11d8766ab 100644 >--- a/documentation/brief-yoctoprojectqs/index.rst >+++ b/documentation/brief-yoctoprojectqs/index.rst >@@ -189,7 +189,7 @@ an entire Linux distribution, including the toolchain, from source. > > The Yocto Project has extensive documentation about OE including a reference > manual which can be found at: >- http://yoctoproject.org/documentation >+ https://docs.yoctoproject.org > Please use :yocto_docs: extlink here. IIRC, :yocto_docs:`/` should do just fine. You can find the list of our extlinks in documentation/conf.py. They can be used in rST files (so your change in README is fine). > For more information about OpenEmbedded see their website: > http://www.openembedded.org And a free patch here with :oe_home:`/` :) Thanks for the patch! Quentin ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [PATCH 1/1] Update documentation URL 2021-03-20 11:16 ` [docs] " Quentin Schulz @ 2021-03-22 14:46 ` Michael Opdenacker 2021-03-23 9:27 ` Quentin Schulz 0 siblings, 1 reply; 6+ messages in thread From: Michael Opdenacker @ 2021-03-22 14:46 UTC (permalink / raw) To: Quentin Schulz, docs; +Cc: michael.opdenacker Hi Quentin, Nice to hear from you again, and thanks for your help! > Please use :yocto_docs: extlink here. IIRC, :yocto_docs:`/` should do just fine. Oops, actually, this doesn't work here, as we are in a "code-block". The patch didn't give you enough context for you to see this. > > You can find the list of our extlinks in documentation/conf.py. They can be used in rST files (so your change in README is fine). This is very good to know, thanks! Apparently, these shortcuts don't work in the toplevel index.rst file though... That was tempting to use them there too. Anyway, I'll use them in normal documentation. > >> For more information about OpenEmbedded see their website: >> http://www.openembedded.org > And a free patch here with :oe_home:`/` :) Same here, unfortunately. So, I believe my patch can be taken as is... Cheers, Michael. -- Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [PATCH 1/1] Update documentation URL 2021-03-22 14:46 ` Michael Opdenacker @ 2021-03-23 9:27 ` Quentin Schulz 2021-03-31 9:22 ` Michael Opdenacker 0 siblings, 1 reply; 6+ messages in thread From: Quentin Schulz @ 2021-03-23 9:27 UTC (permalink / raw) To: Michael Opdenacker; +Cc: Quentin Schulz, docs Hi Michael, On Mon, Mar 22, 2021 at 03:46:55PM +0100, Michael Opdenacker wrote: > Hi Quentin, > > Nice to hear from you again, and thanks for your help! > Nice to see you contribute to the project :) Here's to many more patches. > > Please use :yocto_docs: extlink here. IIRC, :yocto_docs:`/` should do just fine. > > > Oops, actually, this doesn't work here, as we are in a "code-block". The > patch didn't give you enough context for you to see this. > Ah the eternal struggle with literal blocks. We should check if those the same links appear often in literal blocks and then maybe have an entry in poky.yaml for those for easier maintenance. Later work anyway :) > > > > You can find the list of our extlinks in documentation/conf.py. They can be used in rST files (so your change in README is fine). > > > This is very good to know, thanks! > > Apparently, these shortcuts don't work in the toplevel index.rst file > though... That was tempting to use them there too. Anyway, I'll use them > in normal documentation. > Indeed, probably related to the use of .. toc-tree directive. The goal in the end is to have as few places as possible where manual maintenance and monitoring is required. index.html is anyway so critical that I doubt it'll stay broken for long if it ever happens to be broken :) > > > > >> For more information about OpenEmbedded see their website: > >> http://www.openembedded.org > > And a free patch here with :oe_home:`/` :) > > > Same here, unfortunately. > > So, I believe my patch can be taken as is... > Works for me. Reviewed-by: Quentin Schulz <foss@0leil.net> Cheers, Quentin ^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [docs] [PATCH 1/1] Update documentation URL 2021-03-23 9:27 ` Quentin Schulz @ 2021-03-31 9:22 ` Michael Opdenacker 0 siblings, 0 replies; 6+ messages in thread From: Michael Opdenacker @ 2021-03-31 9:22 UTC (permalink / raw) To: Quentin Schulz; +Cc: docs Hi Quentin, On 3/23/21 10:27 AM, Quentin Schulz wrote: > Ah the eternal struggle with literal blocks. We should check if those > the same links appear often in literal blocks and then maybe have an > entry in poky.yaml for those for easier maintenance. Thanks for the suggestion. I added that to my todo list. Thanks to your review, the patch is now in master-next: http://git.yoctoproject.org/cgit/cgit.cgi/yocto-docs/commit/?h=master-next&id=87315f3fa6664f6ac588935b4ac67bacbee0de13 Cheers, Michael. -- Michael Opdenacker, Bootlin Embedded Linux and Kernel engineering https://bootlin.com ^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-03-31 9:22 UTC | newest] Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2021-03-19 18:13 [PATCH 0/1] Update documentation URL Michael Opdenacker 2021-03-19 18:13 ` [PATCH 1/1] " Michael Opdenacker 2021-03-20 11:16 ` [docs] " Quentin Schulz 2021-03-22 14:46 ` Michael Opdenacker 2021-03-23 9:27 ` Quentin Schulz 2021-03-31 9:22 ` Michael Opdenacker
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.