Skip to contentSkip to conversation

README.poky: Update to switch to markdown format and update

PATCH In review Richard Purdie 2 participants 4 messages Jun 7, 2021 – Jun 8, 2021 1 message not in the archive

lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): [email protected]

#1 lore raw

PATCH 1/1 README.poky: Update to switch to markdown format and update

Mentioning on the docs list.

I a plan is forming to migrate the various READMEs in the repos to markdown format and display these in the git web interface in the about page. If this merges I'll work with MichaelH to make sure it displays properly on the about page.

I've had a go at improving the poky one which needed a bit of modernisation anyway. Help with others welcome.

I am a little torn on this as it does make the README harder to read outside of rendered interfaces.

Cheers,

Richard

---
 README.poky => README.poky.md |  0
 meta-poky/README.poky         | 77 ++++++++++++++---------------------
 2 files changed, 30 insertions(+), 47 deletions(-)
 rename README.poky => README.poky.md (100%)
README.poky.md renamed from README.poky +0 -0
similarity index 100%
rename from README.poky
rename to README.poky.md
meta-poky/README.poky +30 -47

97 lines not on this page · raw message

Signature · 1 line
2.30.2

-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#12461): https://lists.yoctoproject.org/g/poky/message/12461
Mute This Topic: https://lists.yoctoproject.org/mt/83372875/1686473
Group Owner: [email protected]
Unsubscribe: https://lists.yoctoproject.org/g/poky/unsub [[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-

#2 lore raw

Hi Richard,

Quoted 4 lines · Richard Purdie

Mentioning on the docs list.

I a plan is forming to migrate the various READMEs in the repos to markdown format and display these in the git web interface in the about page. If this

Does it need to be in MarkDown format to be displayed in the About section?

Quoted 6 lines

merges I'll work with MichaelH to make sure it displays properly on the about page.

I've had a go at improving the poky one which needed a bit of modernisation anyway. Help with others welcome.

Anyway to have those two changes separate so we can properly review each separately?

Quoted 3 lines

I am a little torn on this as it does make the README harder to read outside of rendered interfaces.

But it'd be displayed correctly in the Github mirror and Gitlab for those using it I guess.

Most projects hosted on Github/Gitlab use MarkDown so I don't think it's such a bad idea, I'm just not sure it has as much benefit on cgit since it's not the landing page of the repo (the summary page is).

If we can display the non-MD version in the about page, I don't think there's a huge benefit of migrating to MD?

If we absolutely need MD for the about page, go for it as it'll cover Github, Gitlab and probably others.

We might want to modify bitbake-layers create-layer to provide a README.md too instead of the current template?

Cheers,
Quentin

#3 lore raw
Quoted 10 lines · Quentin Schulz

Hi Richard,

Quoted 4 lines · Richard Purdie

Mentioning on the docs list.

I a plan is forming to migrate the various READMEs in the repos to markdown format and display these in the git web interface in the about page. If this

Does it need to be in MarkDown format to be displayed in the About section?

No, but it does help a little and see below.

Quoted 9 lines
Quoted 6 lines

merges I'll work with MichaelH to make sure it displays properly on the about page.

I've had a go at improving the poky one which needed a bit of modernisation anyway. Help with others welcome.

Anyway to have those two changes separate so we can properly review each separately?

I can reverse engineer them back apart I guess, I just couldn't bring myself to leave it as it was as it needed reformatting and so on anyway.

Quoted 11 lines
Quoted 3 lines

I am a little torn on this as it does make the README harder to read outside of rendered interfaces.

But it'd be displayed correctly in the Github mirror and Gitlab for those using it I guess.

Most projects hosted on Github/Gitlab use MarkDown so I don't think it's such a bad idea, I'm just not sure it has as much benefit on cgit since it's not the landing page of the repo (the summary page is).

Quoted 8 lines

If we can display the non-MD version in the about page, I don't think there's a huge benefit of migrating to MD?

If we absolutely need MD for the about page, go for it as it'll cover Github, Gitlab and probably others.

We might want to modify bitbake-layers create-layer to provide a README.md too instead of the current template?

There is the issue of needing to display a best practices badge somewhere for the project which only really makes sense in markdown format which kind of pushed me into this.

Cheers,

Richard

#4 lore raw

Hi Richard,

Quoted 21 lines · Richard Purdie
Quoted 10 lines · Quentin Schulz

Hi Richard,

Quoted 4 lines · Richard Purdie

Mentioning on the docs list.

I a plan is forming to migrate the various READMEs in the repos to markdown format and display these in the git web interface in the about page. If this

Does it need to be in MarkDown format to be displayed in the About section?

No, but it does help a little and see below.

Quoted 7 lines
Quoted 6 lines

merges I'll work with MichaelH to make sure it displays properly on the about page.

I've had a go at improving the poky one which needed a bit of modernisation anyway. Help with others welcome.

Quoted 6 lines
Quoted 2 lines

Anyway to have those two changes separate so we can properly review each separately?

I can reverse engineer them back apart I guess, I just couldn't bring myself to leave it as it was as it needed reformatting and so on anyway.

The constant struggle of trying not to fix everything at once in the docs :)

Quoted 17 lines
Quoted 17 lines
Quoted 3 lines

I am a little torn on this as it does make the README harder to read outside of rendered interfaces.

But it'd be displayed correctly in the Github mirror and Gitlab for those using it I guess.

Most projects hosted on Github/Gitlab use MarkDown so I don't think it's such a bad idea, I'm just not sure it has as much benefit on cgit since it's not the landing page of the repo (the summary page is).

If we can display the non-MD version in the about page, I don't think there's a huge benefit of migrating to MD?

If we absolutely need MD for the about page, go for it as it'll cover Github, Gitlab and probably others.

Quoted 7 lines
Quoted 2 lines

We might want to modify bitbake-layers create-layer to provide a README.md too instead of the current template?

There is the issue of needing to display a best practices badge somewhere for the project which only really makes sense in markdown format which kind of pushed me into this.

It's all settled then :)

MarkDown is not that much less readable than plain text anyway, it can easily be picked up by anyone, so no objection on my part. LGTM.

Cheers,
Quentin