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.

Sign up for GitHub

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

Jump to bottom

[gov, common]: Convert to rst #2737

Merged
merged 10 commits into from
May 2, 2022
Merged

[gov, common]: Convert to rst #2737

merged 10 commits into from
May 2, 2022

Conversation

CsatariGergely
Copy link
Collaborator

  • Removal of raw HTML elements
  • Removal of ToC
  • Removal of bogometers
  • Adding new line before and after lists
  • Harmonizing buleted lists to use *
  • Adding new line before and after headings

@CsatariGergely
[rst]: Markdown corrections to common and gov
1a4f535 
* Removal of raw HTML elements
* Removal of ToC
* Removal of bogometers
* Adding new line before and after lists
* Harmonizing buleted lists to use *
* Adding new line before and after headings

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
[GOV, Common]: Markdown correction to release notes, image captions
49c7e0a 
Implementing the markdown corrections to the release notes
Adding the image captions to the corrected markdowns in GOV and Common

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@pgoyal01
Copy link
Collaborator

pgoyal01 commented Dec 3, 2021

Figure numbers do not render

@CsatariGergely
Copy link
Collaborator Author

Figure numbers do not render

Fixed in 49c7e0a

@CsatariGergely CsatariGergely marked this pull request as draft December 3, 2021 08:56
@CsatariGergely
Copy link
Collaborator Author

I moved this to draft as I would like to convert to rst already in this pr.

@CsatariGergely CsatariGergely changed the title [rst]: Markdown corrections to common and gov [gov, common]: Convert to rst Dec 23, 2021
@CsatariGergely CsatariGergely marked this pull request as ready for review December 23, 2021 10:05
@CsatariGergely CsatariGergely requested a review from a team December 23, 2021 10:06
@CsatariGergely
[common]: Removal of misnamed figure
dcc60ec 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
pgoyal01
pgoyal01 reviewed Dec 27, 2021
View reviewed changes
doc/common/chapter00.rst Outdated Show resolved Hide resolved
pgoyal01
pgoyal01 reviewed Dec 27, 2021
View reviewed changes
doc/common/chapter00.rst Outdated Show resolved Hide resolved
pgoyal01
pgoyal01 reviewed Dec 27, 2021
View reviewed changes
doc/common/chapter00.rst Outdated Show resolved Hide resolved
pgoyal01
pgoyal01 reviewed Dec 27, 2021
View reviewed changes
doc/common/roadmap.rst

**Definitions**

A project (aka WS) is:
Copy link
Collaborator

@pgoyal01 pgoyal01 Dec 27, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

This and "Releases" are not section headings and so wouldn't have implicit references - for milestones an explicit reference has been created (line 61) :

Projects <#project>__ and Releases <#release>__

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Are there any links pointing to here?

I'm a bit lost now with the implicit header anchoring. In my view they work only until we use links to .md files and use the relative link corrector extension. Later we can use sphinx.ext.autosectionlabel or we can just add labels manually. Any opinions or preferences? @pgoyal01 , @karinesevilla , @gkunz , @collivier ?

@CsatariGergely
[gov, common]: Correction of relative links
baaa3ac 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely CsatariGergely mentioned this pull request Dec 29, 2021
Merged
pgoyal01
pgoyal01 reviewed Jan 18, 2022
View reviewed changes
doc/README.md Outdated Show resolved Hide resolved
@CsatariGergely
[common] Replacing doc/README.md with doc/index.rst
a75a857 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
Copy link
Collaborator Author

@pgoyal01 can you please close the conversations if you accept my comments or add a comment if not.
@walterkozlowski can you please review?

bfcohen100
bfcohen100 approved these changes Mar 1, 2022
View reviewed changes
Copy link
Contributor

@bfcohen100 bfcohen100 left a comment

Choose a reason for hiding this comment

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

Looks like the links have been addressed.

@CsatariGergely
Merge branch 'master' into common-rst-markdown-corrections
0af93c1 
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely
Merge branch 'common-rst-markdown-corrections' of github.com:nokia/CN…
590c02c 
…TT into common-rst-markdown-corrections

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
@CsatariGergely CsatariGergely added the Merge-Ready Author of PR signals ready for merge (by Code Owner) label Apr 20, 2022
@CsatariGergely
Copy link
Collaborator Author

@walterkozlowski can you please merge?

@wmk-admin wmk-admin merged commit 5b382de into anuket-project:master May 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bfcohen100 bfcohen100 bfcohen100 approved these changes

@gkunz gkunz gkunz approved these changes

@pgoyal01 pgoyal01 pgoyal01 approved these changes

@collivier collivier Awaiting requested review from collivier collivier is a code owner

@acmacm acmacm Awaiting requested review from acmacm

@scottsteinbrueck scottsteinbrueck Awaiting requested review from scottsteinbrueck

@karinesevilla karinesevilla Awaiting requested review from karinesevilla

@bfcohen bfcohen Awaiting requested review from bfcohen bfcohen is a code owner

@ss8171 ss8171 Awaiting requested review from ss8171

@walterkozlowski walterkozlowski Awaiting requested review from walterkozlowski walterkozlowski is a code owner

@steelescotr steelescotr Awaiting requested review from steelescotr

Assignees
No one assigned
Labels
Merge-Ready Author of PR signals ready for merge (by Code Owner)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@CsatariGergely @pgoyal01 @bfcohen100 @gkunz @wmk-admin