Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add release document #154

Merged
merged 4 commits into from Feb 21, 2021
Merged

Conversation

hakehuang
Copy link
Contributor

@hakehuang hakehuang commented Dec 8, 2020

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
Copy link
Contributor Author

@hakehuang hakehuang commented Dec 8, 2020

@nashif would this be ok?

Copy link
Member

@nashif nashif left a comment

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

@hakehuang
Copy link
Contributor Author

@hakehuang hakehuang commented Dec 16, 2020

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

@nashif update to rcs format, please check.

@hakehuang hakehuang requested a review from nashif Dec 17, 2020
Copy link
Member

@nashif nashif left a comment

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

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


OVERVIEW
Copy link
Member

@nashif nashif Dec 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do not use all caps

Copy link
Contributor Author

@hakehuang hakehuang Dec 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, done



OVERVIEW
************************************
Copy link
Member

@nashif nashif Dec 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be same length as the title.

Copy link
Contributor Author

@hakehuang hakehuang Dec 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, done.

@@ -0,0 +1,208 @@

TEST RESULTS
Copy link
Member

@nashif nashif Dec 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do not use all caps

Copy link
Contributor Author

@hakehuang hakehuang Dec 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, done

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>
nashif
nashif approved these changes Jan 11, 2021
@nashif nashif requested a review from PerMac Jan 11, 2021
@abrodkin
Copy link

@abrodkin abrodkin commented Jan 18, 2021

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
Copy link
Contributor Author

@hakehuang hakehuang commented Jan 19, 2021

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
Copy link
Contributor Author

@hakehuang hakehuang commented Jan 19, 2021

@abrodkin I add rst2pdf support, please check

@abrodkin
Copy link

@abrodkin abrodkin commented Jan 20, 2021

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

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.
Copy link

@LeiW000 LeiW000 Jan 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

" ' " should not removed.

Copy link
Contributor Author

@hakehuang hakehuang Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

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

@LeiW000 LeiW000 Jan 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be "2.5"?

Copy link
Contributor Author

@hakehuang hakehuang Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v2.5 content added



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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

@hakehuang hakehuang Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I remove it

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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra spaces:

... Zephyr RTOS version __.

Copy link
Contributor Author

@hakehuang hakehuang Jan 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix it

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 hakehuang force-pushed the release_document branch 2 times, most recently from 85a0b67 to aaf3359 Compare Feb 1, 2021
@hakehuang hakehuang force-pushed the release_document branch 2 times, most recently from f25858f to 28faa75 Compare Feb 8, 2021
add summary page for v2.5.0, some details still pending

Signed-off-by: Hake Huang <hake.huang@oss.nxp.com>
@nashif nashif merged commit f122c99 into zephyrproject-rtos:master Feb 21, 2021
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants