| Message ID | 20211124150928.11645-1-anuj.mittal@intel.com |
|---|---|
| State | New |
| Headers | show |
| Series | [honister] documentation: prepare for 3.4.1 release | expand |
Hi Anuj, On 11/24/21 4:09 PM, Anuj Mittal wrote: > Also include reference to just release 3.3.4. > > Signed-off-by: Anuj Mittal <anuj.mittal@intel.com> > --- > documentation/conf.py | 2 +- > documentation/poky.yaml | 10 +++++----- > documentation/releases.rst | 2 ++ > 3 files changed, 8 insertions(+), 6 deletions(-) > > diff --git a/documentation/conf.py b/documentation/conf.py > index 104b49ea0..9fd836a35 100644 > --- a/documentation/conf.py > +++ b/documentation/conf.py > @@ -16,7 +16,7 @@ import os > import sys > import datetime > > -current_version = "3.4" > +current_version = "3.4.1" > > # String used in sidebar > version = 'Version: ' + current_version > diff --git a/documentation/poky.yaml b/documentation/poky.yaml > index f2d1e8b97..11e209e30 100644 > --- a/documentation/poky.yaml > +++ b/documentation/poky.yaml > @@ -1,12 +1,12 @@ > -DISTRO : "3.4" > +DISTRO : "3.4.1" > DISTRO_NAME_NO_CAP : "honister" > DISTRO_NAME : "Honister" > DISTRO_NAME_NO_CAP_MINUS_ONE : "hardknott" > DISTRO_NAME_NO_CAP_LTS : "dunfell" > -YOCTO_DOC_VERSION : "3.4" > -YOCTO_DOC_VERSION_MINUS_ONE : "3.3.3" > -DISTRO_REL_TAG : "yocto-3.4" > -POKYVERSION : "26.0.0" > +YOCTO_DOC_VERSION : "3.4.1" > +YOCTO_DOC_VERSION_MINUS_ONE : "3.3.4" > +DISTRO_REL_TAG : "yocto-3.4.1" > +POKYVERSION : "26.0.1" > YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" > YOCTO_DL_URL : "https://downloads.yoctoproject.org" > YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" > diff --git a/documentation/releases.rst b/documentation/releases.rst > index 529d00e70..6f7bca540 100644 > --- a/documentation/releases.rst > +++ b/documentation/releases.rst > @@ -9,6 +9,7 @@ Release Series 3.4 (honister) > ****************************** > > - :yocto_docs:`3.4 Documentation </3.4>` > +- :yocto_docs:`3.4.1 Documentation </3.4.1>` > > ****************************** > Release Series 3.3 (hardknott) > @@ -18,6 +19,7 @@ Release Series 3.3 (hardknott) > - :yocto_docs:`3.3.1 Documentation </3.3.1>` > - :yocto_docs:`3.3.2 Documentation </3.3.2>` > - :yocto_docs:`3.3.3 Documentation </3.3.3>` > +- :yocto_docs:`3.3.4 Documentation </3.3.4>` > > ******************************* > Release Series 3.2 (gatesgarth) Many thanks for these updates! Just to be sure... when do you expect me to merge these changes? Before the release so that everything is all set in the docs when the release is out? Or right after the release is made so that the docs don't refer to a release that is not available yet? Thanks in advance Michael.
Hello, On 11/24/21 4:21 PM, Michael Opdenacker wrote: > Hi Anuj, > > On 11/24/21 4:09 PM, Anuj Mittal wrote: >> Also include reference to just release 3.3.4. >> >> Signed-off-by: Anuj Mittal <anuj.mittal@intel.com> >> --- >> documentation/conf.py | 2 +- >> documentation/poky.yaml | 10 +++++----- >> documentation/releases.rst | 2 ++ >> 3 files changed, 8 insertions(+), 6 deletions(-) >> >> diff --git a/documentation/conf.py b/documentation/conf.py >> index 104b49ea0..9fd836a35 100644 >> --- a/documentation/conf.py >> +++ b/documentation/conf.py >> @@ -16,7 +16,7 @@ import os >> import sys >> import datetime >> >> -current_version = "3.4" >> +current_version = "3.4.1" >> >> # String used in sidebar >> version = 'Version: ' + current_version >> diff --git a/documentation/poky.yaml b/documentation/poky.yaml >> index f2d1e8b97..11e209e30 100644 >> --- a/documentation/poky.yaml >> +++ b/documentation/poky.yaml >> @@ -1,12 +1,12 @@ >> -DISTRO : "3.4" >> +DISTRO : "3.4.1" >> DISTRO_NAME_NO_CAP : "honister" >> DISTRO_NAME : "Honister" >> DISTRO_NAME_NO_CAP_MINUS_ONE : "hardknott" >> DISTRO_NAME_NO_CAP_LTS : "dunfell" >> -YOCTO_DOC_VERSION : "3.4" >> -YOCTO_DOC_VERSION_MINUS_ONE : "3.3.3" >> -DISTRO_REL_TAG : "yocto-3.4" >> -POKYVERSION : "26.0.0" >> +YOCTO_DOC_VERSION : "3.4.1" >> +YOCTO_DOC_VERSION_MINUS_ONE : "3.3.4" >> +DISTRO_REL_TAG : "yocto-3.4.1" >> +POKYVERSION : "26.0.1" >> YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" >> YOCTO_DL_URL : "https://downloads.yoctoproject.org" >> YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" >> diff --git a/documentation/releases.rst b/documentation/releases.rst >> index 529d00e70..6f7bca540 100644 >> --- a/documentation/releases.rst >> +++ b/documentation/releases.rst >> @@ -9,6 +9,7 @@ Release Series 3.4 (honister) >> ****************************** >> >> - :yocto_docs:`3.4 Documentation </3.4>` >> +- :yocto_docs:`3.4.1 Documentation </3.4.1>` >> >> ****************************** >> Release Series 3.3 (hardknott) >> @@ -18,6 +19,7 @@ Release Series 3.3 (hardknott) >> - :yocto_docs:`3.3.1 Documentation </3.3.1>` >> - :yocto_docs:`3.3.2 Documentation </3.3.2>` >> - :yocto_docs:`3.3.3 Documentation </3.3.3>` >> +- :yocto_docs:`3.3.4 Documentation </3.3.4>` >> >> ******************************* >> Release Series 3.2 (gatesgarth) > > Many thanks for these updates! > Just to be sure... when do you expect me to merge these changes? > Before the release so that everything is all set in the docs when the > release is out? > Or right after the release is made so that the docs don't refer to a > release that is not available yet? I guess that the second option (waiting for the release) is the correct one. I'm saying this because I updated releases.rst too early on master, to include the 3.1.12 release, and this causes issues: * Go to https://docs.yoctoproject.org/releases.html * Click on https://docs.yoctoproject.org/3.1.12 -> Not found * Click on https://docs.yoctoproject.org/3.1.11/ -> You get a red warning: "This document is for outdated version 3.1.11, you should select the latest release version in this series, 3.1.12.". This is wrong because the 3.1.12 manual is not available yet, because we don't have the "yocto-3.1.12" tag yet, right? So, I'd even say that the first line for this patch should be "documentation: update for 3.4.1 release" ("update" instead of "prepare"), if I'm supposed to apply it after the release is out. Please correct me if I'm wrong. Sorry for the time it took me to (start to) understand the process to generate docs. Michael.
On Wed, 2021-11-24 at 21:57 +0100, Michael Opdenacker wrote: > Hello, > > On 11/24/21 4:21 PM, Michael Opdenacker wrote: > > Hi Anuj, > > > > On 11/24/21 4:09 PM, Anuj Mittal wrote: > > > Also include reference to just release 3.3.4. > > > > > > Signed-off-by: Anuj Mittal <anuj.mittal@intel.com> > > > --- > > > documentation/conf.py | 2 +- > > > documentation/poky.yaml | 10 +++++----- > > > documentation/releases.rst | 2 ++ > > > 3 files changed, 8 insertions(+), 6 deletions(-) > > > > > > diff --git a/documentation/conf.py b/documentation/conf.py > > > index 104b49ea0..9fd836a35 100644 > > > --- a/documentation/conf.py > > > +++ b/documentation/conf.py > > > @@ -16,7 +16,7 @@ import os > > > import sys > > > import datetime > > > > > > -current_version = "3.4" > > > +current_version = "3.4.1" > > > > > > # String used in sidebar > > > version = 'Version: ' + current_version > > > diff --git a/documentation/poky.yaml b/documentation/poky.yaml > > > index f2d1e8b97..11e209e30 100644 > > > --- a/documentation/poky.yaml > > > +++ b/documentation/poky.yaml > > > @@ -1,12 +1,12 @@ > > > -DISTRO : "3.4" > > > +DISTRO : "3.4.1" > > > DISTRO_NAME_NO_CAP : "honister" > > > DISTRO_NAME : "Honister" > > > DISTRO_NAME_NO_CAP_MINUS_ONE : "hardknott" > > > DISTRO_NAME_NO_CAP_LTS : "dunfell" > > > -YOCTO_DOC_VERSION : "3.4" > > > -YOCTO_DOC_VERSION_MINUS_ONE : "3.3.3" > > > -DISTRO_REL_TAG : "yocto-3.4" > > > -POKYVERSION : "26.0.0" > > > +YOCTO_DOC_VERSION : "3.4.1" > > > +YOCTO_DOC_VERSION_MINUS_ONE : "3.3.4" > > > +DISTRO_REL_TAG : "yocto-3.4.1" > > > +POKYVERSION : "26.0.1" > > > YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" > > > YOCTO_DL_URL : "https://downloads.yoctoproject.org" > > > YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" > > > diff --git a/documentation/releases.rst > > > b/documentation/releases.rst > > > index 529d00e70..6f7bca540 100644 > > > --- a/documentation/releases.rst > > > +++ b/documentation/releases.rst > > > @@ -9,6 +9,7 @@ Release Series 3.4 (honister) > > > ****************************** > > > > > > - :yocto_docs:`3.4 Documentation </3.4>` > > > +- :yocto_docs:`3.4.1 Documentation </3.4.1>` > > > > > > ****************************** > > > Release Series 3.3 (hardknott) > > > @@ -18,6 +19,7 @@ Release Series 3.3 (hardknott) > > > - :yocto_docs:`3.3.1 Documentation </3.3.1>` > > > - :yocto_docs:`3.3.2 Documentation </3.3.2>` > > > - :yocto_docs:`3.3.3 Documentation </3.3.3>` > > > +- :yocto_docs:`3.3.4 Documentation </3.3.4>` > > > > > > ******************************* > > > Release Series 3.2 (gatesgarth) > > > > Many thanks for these updates! > > Just to be sure... when do you expect me to merge these changes? > > Before the release so that everything is all set in the docs when > > the > > release is out? > > Or right after the release is made so that the docs don't refer to > > a > > release that is not available yet? > > > I guess that the second option (waiting for the release) is the > correct one. I think we were until now following the first approach. But yes, the second one is probably better and correct. Should I send a v2 after the release has been made? Thanks, Anuj
Hi Anuj, On 11/25/21 3:04 AM, Anuj Mittal wrote: > On Wed, 2021-11-24 at 21:57 +0100, Michael Opdenacker wrote: >>> Many thanks for these updates! >>> Just to be sure... when do you expect me to merge these changes? >>> Before the release so that everything is all set in the docs when >>> the >>> release is out? >>> Or right after the release is made so that the docs don't refer to >>> a >>> release that is not available yet? >> >> I guess that the second option (waiting for the release) is the >> correct one. > I think we were until now following the first approach. But yes, the > second one is probably better and correct. Should I send a v2 after the > release has been made? > > Thanks, > > Anuj Thanks for confirming. No need to modify your commit this time. I'll take care of it. Next time though, you could just have a title saying "update for release..." instead of "prepare for release". Thanks again Michael.
Hi Anuj On 11/25/21 9:58 AM, Michael Opdenacker wrote: > Hi Anuj, > > On 11/25/21 3:04 AM, Anuj Mittal wrote: >> On Wed, 2021-11-24 at 21:57 +0100, Michael Opdenacker wrote: >>>> Many thanks for these updates! >>>> Just to be sure... when do you expect me to merge these changes? >>>> Before the release so that everything is all set in the docs when >>>> the >>>> release is out? >>>> Or right after the release is made so that the docs don't refer to >>>> a >>>> release that is not available yet? >>> I guess that the second option (waiting for the release) is the >>> correct one. >> I think we were until now following the first approach. But yes, the >> second one is probably better and correct. Should I send a v2 after the >> release has been made? >> >> Thanks, >> >> Anuj > > Thanks for confirming. > No need to modify your commit this time. I'll take care of it. > Next time though, you could just have a title saying "update for > release..." instead of "prepare for release". Done now. I actually had to implement the patch again. https://git.yoctoproject.org/yocto-docs/commit/?h=honister&id=a6b10a8e2491e284e7faf439fa196605ddf40943 (honister branch) This was also an opportunity to update other branches with respect to available releases: Hardknott: https://git.yoctoproject.org/yocto-docs/commit/?h=hardknott&id=3d0b9af776cd278ca2cb86de9a4aaf0d7ddfa87a Dunfell: https://git.yoctoproject.org/yocto-docs/commit/?h=dunfell&id=77db6738d58ba4bdc68deb74775c00a332fcc86c And Michael Halstead took care of master: https://git.yoctoproject.org/yocto-docs/commit/?id=7d503d765f5a8ade226c897a17aecd0856104af1 Thanks again Michael.
diff --git a/documentation/conf.py b/documentation/conf.py index 104b49ea0..9fd836a35 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -16,7 +16,7 @@ import os import sys import datetime -current_version = "3.4" +current_version = "3.4.1" # String used in sidebar version = 'Version: ' + current_version diff --git a/documentation/poky.yaml b/documentation/poky.yaml index f2d1e8b97..11e209e30 100644 --- a/documentation/poky.yaml +++ b/documentation/poky.yaml @@ -1,12 +1,12 @@ -DISTRO : "3.4" +DISTRO : "3.4.1" DISTRO_NAME_NO_CAP : "honister" DISTRO_NAME : "Honister" DISTRO_NAME_NO_CAP_MINUS_ONE : "hardknott" DISTRO_NAME_NO_CAP_LTS : "dunfell" -YOCTO_DOC_VERSION : "3.4" -YOCTO_DOC_VERSION_MINUS_ONE : "3.3.3" -DISTRO_REL_TAG : "yocto-3.4" -POKYVERSION : "26.0.0" +YOCTO_DOC_VERSION : "3.4.1" +YOCTO_DOC_VERSION_MINUS_ONE : "3.3.4" +DISTRO_REL_TAG : "yocto-3.4.1" +POKYVERSION : "26.0.1" YOCTO_POKY : "poky-&DISTRO_NAME_NO_CAP;-&POKYVERSION;" YOCTO_DL_URL : "https://downloads.yoctoproject.org" YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" diff --git a/documentation/releases.rst b/documentation/releases.rst index 529d00e70..6f7bca540 100644 --- a/documentation/releases.rst +++ b/documentation/releases.rst @@ -9,6 +9,7 @@ Release Series 3.4 (honister) ****************************** - :yocto_docs:`3.4 Documentation </3.4>` +- :yocto_docs:`3.4.1 Documentation </3.4.1>` ****************************** Release Series 3.3 (hardknott) @@ -18,6 +19,7 @@ Release Series 3.3 (hardknott) - :yocto_docs:`3.3.1 Documentation </3.3.1>` - :yocto_docs:`3.3.2 Documentation </3.3.2>` - :yocto_docs:`3.3.3 Documentation </3.3.3>` +- :yocto_docs:`3.3.4 Documentation </3.3.4>` ******************************* Release Series 3.2 (gatesgarth)
Also include reference to just release 3.3.4. Signed-off-by: Anuj Mittal <anuj.mittal@intel.com> --- documentation/conf.py | 2 +- documentation/poky.yaml | 10 +++++----- documentation/releases.rst | 2 ++ 3 files changed, 8 insertions(+), 6 deletions(-)