doc: add release document #154

hakehuang · 2020-12-08T15:39:25Z

put release report documnet here so that more audiences can share
their comments.

please create issue in test_result repo for any comments.

Signed-off-by: Hake Huang hake.huang@oss.nxp.com

hakehuang · 2020-12-08T15:40:01Z

@nashif would this be ok?

nashif

I would rather see the documents in text format( for example .rst) and not microsoft doc.

hakehuang · 2020-12-16T10:26:53Z

I would rather see the documents in text format( for example .rst) and not microsoft doc.

@nashif update to rcs format, please check.

nashif

split into multiple commits, one adding the doc infra and another adding the actual doc.

nashif · 2020-12-17T14:42:36Z

doc/reports/prelude.rst

+############################
+
+
+OVERVIEW


do not use all caps

nashif · 2020-12-17T14:43:01Z

doc/reports/prelude.rst

+
+
+OVERVIEW
+************************************


this should be same length as the title.

nashif · 2020-12-17T14:43:23Z

doc/reports/summary.rst

@@ -0,0 +1,208 @@
+
+TEST RESULTS


do not use all caps

add doc build stuff Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>

convert the MS word document to rst format run below to see the result: make html please follow to setup envirnment https://www.sphinx-doc.org/en/master/usage/installation.html Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>

abrodkin · 2021-01-18T11:27:05Z

Looks like LaTeX is being used for building, while from my experience it's always a pain to get LaTeX distribution installed.
Thus I would suggest to use rst2pdf (https://rst2pdf.org/). Its installation is as simple as pip install rst2pdf. Though some quite trivial changes needs to be done in doc/conf.py:

extensions = [
    # ...
    'rst2pdf.pdfbuilder',
]

# Grouping the document tree into PDF files. List of tuples
# (source start file, target name, title, author, options).
pdf_documents = [
    ('index', 'MyProject', 'My Project', 'Author Name'),
]

Or see more details in the official manual: https://rst2pdf.org/static/manual.pdf.

hakehuang · 2021-01-19T02:21:24Z

Looks like LaTeX is being used for building, while from my experience it's always a pain to get LaTeX distribution installed.
Thus I would suggest to use rst2pdf (https://rst2pdf.org/). Its installation is as simple as pip install rst2pdf. Though some quite trivial changes needs to be done in doc/conf.py:
extensions = [
    # ...
    'rst2pdf.pdfbuilder',
]

# Grouping the document tree into PDF files. List of tuples
# (source start file, target name, title, author, options).
pdf_documents = [
    ('index', 'MyProject', 'My Project', 'Author Name'),
]
Or see more details in the official manual: https://rst2pdf.org/static/manual.pdf.

the tools installation is based on below guider. I am not generating pdf but html format, though. let me try you method
https://www.sphinx-doc.org/en/master/usage/installation.html

now the rst2pdf is supported.

hakehuang · 2021-01-19T03:30:02Z

@abrodkin I add rst2pdf support, please check

abrodkin · 2021-01-20T16:39:53Z

Thanks, @hakehuang!

FWIW that's what I got generated with:

$ make pdf

Running Sphinx v2.0.0+/5a1e3ff
making output directory... done
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [pdf]: targets for 3 source files that are out of date
updating environment: 0 added, 0 changed, 0 removed
looking for now-outdated files... none found
processing ZephyrQualityManagement...
index
reports/prelude
reports/summary
resolving references...
done
writing ZephyrQualityManagement...
done
build succeeded.

ZephyrQualityManagement.pdf

LeiW000 · 2021-01-26T12:55:20Z

doc/reports/prelude.rst

+Legal
+=====
+
+Testing WG community does not make any representations or warranties as to the accuracy of the information, quality, reliability, functionality or compatibility. Names and brands in that report may be claimed as the property of others. Our Testing WG community members don't receive any commercial benefit from the board’s manufacturers. We obtain test results using boards which we have on hands during our daily work. If you want your platform results to be added here, you can send your test results by contacting the Testing WG community using that email Testing community will not verify data provided by you and doesn’t make any claims about the reliability and correctness of it. We understand that performance and all test results vary depending on system configuration. Provided data below can’not be used in any marketing activities or advertisements. No certification issued for all results which you can view in that document. 


"Provided data below can'not be....."

" ' " should not removed.

LeiW000 · 2021-01-26T12:57:25Z

doc/reports/summary.rst

+|Document            | 1             | 1                     | 0         | 100       |
+--------------------+---------------+-----------------------+-----------+-----------+
+
+.. _API revision: https://docs.zephyrproject.org/latest/releases/release-notes-2.4.html#api-changes


Should be "2.5"?

v2.5 content added

abrodkin · 2021-01-26T20:17:59Z

doc/reports/prelude.rst

+
+
+Word format file can be found `here
+<https://docs.google.com/document/d/12kEprn7uBkD238EZmQkvD9_hHV9ttcea8Ke-MszLRnc/edit>`_


Document by that URL is long outdated. And why mention it here at all if this text version is supposed to be used by people outside of Testing WG?

ok, I remove it

abrodkin · 2021-01-26T20:20:07Z

doc/reports/prelude.rst

+Overview
+********
+
+This report provides the most up to date information about the health and quality of the current Zephyr RTOS version  . This report gathers key metrics describing the state and performance of the current version and the results of its testing. Whenever applied, references for detailed analysis are provided. This report is a part of the Quality Assurance process for the Zephyr RTOS product.


Extra spaces:

... Zephyr RTOS version __.

need upgrade sphinx to 3.8 above run below command to generate pdf sphinx-build.exe -b pdf . _build Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>

add summary page for v2.5.0, some details still pending Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>

hakehuang force-pushed the release_document branch from 0522130 to f350dc7 Compare December 8, 2020 15:42

nashif requested changes Dec 14, 2020

View reviewed changes

hakehuang force-pushed the release_document branch from f350dc7 to cf3a151 Compare December 16, 2020 10:26

hakehuang requested a review from nashif December 17, 2020 02:41

nashif requested changes Dec 17, 2020

View reviewed changes

doc: add doc infarstructure

8b45db4

add doc build stuff Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>

hakehuang force-pushed the release_document branch from cf3a151 to 78c3b36 Compare December 18, 2020 05:47

doc: add release documents initial version

1f8b7b9

convert the MS word document to rst format run below to see the result: make html please follow to setup envirnment https://www.sphinx-doc.org/en/master/usage/installation.html Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>

hakehuang force-pushed the release_document branch from 78c3b36 to 1f8b7b9 Compare December 18, 2020 05:57

hakehuang requested a review from nashif December 21, 2020 03:39

nashif approved these changes Jan 11, 2021

View reviewed changes

nashif requested a review from PerMac January 11, 2021 13:13

LeiW000 suggested changes Jan 26, 2021

View reviewed changes

abrodkin suggested changes Jan 26, 2021

View reviewed changes

add rst2pdf support for pdf generating

5023d8e

need upgrade sphinx to 3.8 above run below command to generate pdf sphinx-build.exe -b pdf . _build Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>

hakehuang force-pushed the release_document branch 2 times, most recently from 85a0b67 to aaf3359 Compare February 1, 2021 16:21

hakehuang force-pushed the release_document branch 2 times, most recently from f25858f to 28faa75 Compare February 8, 2021 04:06

document: add v2.5 content

fb3f6ee

add summary page for v2.5.0, some details still pending Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>

hakehuang force-pushed the release_document branch from 28faa75 to fb3f6ee Compare February 15, 2021 09:27

nashif merged commit f122c99 into zephyrproject-rtos:master Feb 21, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add release document #154

doc: add release document #154

hakehuang commented Dec 8, 2020

hakehuang commented Dec 8, 2020

nashif left a comment

hakehuang commented Dec 16, 2020

nashif left a comment

nashif Dec 17, 2020

hakehuang Dec 18, 2020

nashif Dec 17, 2020

hakehuang Dec 18, 2020

nashif Dec 17, 2020

hakehuang Dec 18, 2020

abrodkin commented Jan 18, 2021

hakehuang commented Jan 19, 2021 •

edited

hakehuang commented Jan 19, 2021

abrodkin commented Jan 20, 2021

LeiW000 Jan 26, 2021

hakehuang Jan 27, 2021

LeiW000 Jan 26, 2021

hakehuang Jan 27, 2021 •

edited

abrodkin Jan 26, 2021

hakehuang Jan 27, 2021

abrodkin Jan 26, 2021

hakehuang Jan 27, 2021



		Word format file can be found `here
		<https://docs.google.com/document/d/12kEprn7uBkD238EZmQkvD9_hHV9ttcea8Ke-MszLRnc/edit>`_

		############################


		OVERVIEW



		OVERVIEW
		************************************

doc: add release document #154

doc: add release document #154

Conversation

hakehuang commented Dec 8, 2020

hakehuang commented Dec 8, 2020

nashif left a comment

Choose a reason for hiding this comment

hakehuang commented Dec 16, 2020

nashif left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abrodkin commented Jan 18, 2021

hakehuang commented Jan 19, 2021 • edited

hakehuang commented Jan 19, 2021

abrodkin commented Jan 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hakehuang Jan 27, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hakehuang commented Jan 19, 2021 •

edited

hakehuang Jan 27, 2021 •

edited