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

[README.md] Refactoring of the README file #722

Merged
merged 5 commits into from
Jul 8, 2018

Conversation

Confectrician
Copy link
Contributor

Since ther will be many things to change and to discuss,
i wanted to provide a WIP PR so we can directly have a look at adaptions and compare them.

Fixes #720 at some time. 😄

Signed-off-by: Jerome Luckenbach github@luckenba.ch

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
@Confectrician Confectrician added this to the Website redesign milestone Jun 15, 2018
@Confectrician Confectrician requested a review from ghys June 15, 2018 16:55
@Confectrician
Copy link
Contributor Author

Discussion please in #720

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
@Confectrician Confectrician changed the base branch from jenkins-tmp-master to master July 8, 2018 14:44
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
@Confectrician Confectrician changed the title [README.md] Refctoring of the README file - WIP [README.md] Refctoring of the README file Jul 8, 2018
@Confectrician
Copy link
Contributor Author

Hey @ghys,

I have done some writing, maybe you can have a look at it.
Would be nice to have the readme updated in the nearer future since this PR reflects the new repo structure.

@Confectrician Confectrician changed the title [README.md] Refctoring of the README file [README.md] Refactoring of the README file Jul 8, 2018
Signed-off-by: Yannick Schaus <github@schaus.net>
@ghys
Copy link
Member

ghys commented Jul 8, 2018

@Confectrician thanks! You nailed most of it I think.
Instead of reviewing since I have commit rights I have made further changes directly and (I think) improvements to the file in 6f5bf8a - now your turn to have a look 😉

@Confectrician
Copy link
Contributor Author

Looks fine so far.
One question.

You have changed some parts to have more than one sentence per line.
We usually track down to one sentence per line to keep it tracked in git better.

In jekyll this didn't make a difference for the generated website.
Is vuepress different here?
If not i would like to keep it on one line per sentence.

@ghys
Copy link
Member

ghys commented Jul 8, 2018

You have changed some parts to have more than one sentence per line.
We usually track down to one sentence per line to keep it tracked in git better.

Sorry, I didn't know that.
Feel free to break down to one sentence per line if you make changes, otherwise I'll do it.

@Confectrician
Copy link
Contributor Author

Will do so.

Anything else from your side?
We can improve that of course later again.
I just wanted to have a quick up to date readme, so that people know what they are looking at.

Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
@ghys
Copy link
Member

ghys commented Jul 8, 2018

Anything else from your side?

Not atm - I'm good. I will make updates when I find time to do the "bare-bones VuePress config" in this repo so that we get live updates when working on the docs in master, and Netlify previews.

@Confectrician Confectrician merged commit d0f92a2 into openhab:master Jul 8, 2018
@Confectrician Confectrician deleted the 720-update-readme branch January 12, 2019 19:59
@Confectrician Confectrician added this to the 2.x.x milestone Nov 18, 2022
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.

2 participants