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

readme: tidy up the front matter a little #2273

Merged
merged 1 commit into from
Oct 7, 2023
Merged

readme: tidy up the front matter a little #2273

merged 1 commit into from
Oct 7, 2023

Conversation

thoughtpolice
Copy link
Collaborator

Summary: Just a small rework of the very top-level frontmatter. Now:

  • Uses <div> to center things a little
  • Adds top-level links to the new homepage, installation guide, and tutorial
  • Reworks the disclaimer and 'Introduction' section. After all, a README should first say what the project is! I think this reads much better.

Change-Id: I2d92a21650afec0640add3741d4f20c5

@thoughtpolice
Copy link
Collaborator Author

Rendered.

@thoughtpolice thoughtpolice mentioned this pull request Sep 19, 2023
Closed
4 tasks
martinvonz
martinvonz reviewed Sep 19, 2023
View reviewed changes
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ilyagr
Copy link
Collaborator

ilyagr commented Sep 19, 2023

Looks prettier to me! :)

ilyagr
ilyagr reviewed Sep 20, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
ilyagr
ilyagr reviewed Sep 20, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
ilyagr
ilyagr reviewed Sep 20, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
ilyagr
ilyagr reviewed Oct 3, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@ilyagr
Copy link
Collaborator

ilyagr commented Oct 3, 2023

This looks good to me, but I'll let @martinvonz approve. I still think we need to get rid of the Homepage for now, but I hope it comes back soon. :)

ilyagr
ilyagr reviewed Oct 3, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
ilyagr
ilyagr reviewed Oct 3, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@thoughtpolice thoughtpolice force-pushed the push-xptxxoluopqv branch 2 times, most recently from f2a244f to fb905e1 Compare October 3, 2023 21:16
@thoughtpolice
Copy link
Collaborator Author

thoughtpolice commented Oct 3, 2023 •
edited
Loading

I made a change or two after iterating on the looks:

  • A "License" section. Nothing weird about this; some people might expect it, and I consider putting the license information in the README to be good form.
  • The "This isn't a Google product" disclaimer is now at the end, near the license note. I don't think it's materially relevant to why people are here; hence its movement.
  • Using the (very brand-spankin'-new) blockquoting features to make the "experimental" note more visible.
  • Minor tweaks

@martinvonz
Copy link
Owner

  • The "This isn't a Google product" disclaimer is now at the end, near the license note. I don't think it's materially relevant to why people are here; hence its movement.

I agree, but I wasn't sure if Google's Open Source Programs Office would agree. Reading their documentation, it sounds like we may be able to completely remove the disclaimer since this is no longer just my side project. If I can, I'll send a separate PR to delete it.

martinvonz
martinvonz reviewed Oct 3, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage
0a856d4 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is
martinvonz#2273 (comment).
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage
a85b20f 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
@ilyagr ilyagr mentioned this pull request Oct 4, 2023
Merged
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
8fd0b40 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
d599ea4 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
ed615d0 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
3c31697 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
a2d2c2f 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
7f47fdd 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
9d3dab7 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
bcad68f 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
martinvonz#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit that referenced this pull request Oct 4, 2023
@ilyagr
docs: create a basic homepage for the docs website
2218143 
Before, https://martinvonz.github.io/jj/latest redirected to
https://martinvonz.github.io/jj/latest/install-and-setup.html.

Now, it will direct people to a basic page with a link to
the repo and a few other useful pages.

An additional motivation is the desire to have a homepage to
link to from
#2273 (comment).

Better something very basic than nothing.
ilyagr added a commit to ilyagr/jj that referenced this pull request Oct 4, 2023
@ilyagr
docs index.md: Make README link a bit more reliable
9b45079 
The original link would likely be broken by the change to
the heading title in martinvonz#2273.
@ilyagr ilyagr mentioned this pull request Oct 4, 2023
Merged
ilyagr added a commit that referenced this pull request Oct 4, 2023
@ilyagr
docs index.md: Make README link a bit more reliable
7cfeb72 
The original link would likely be broken by the change to
the heading title in #2273.
@thoughtpolice
Copy link
Collaborator Author

I also split out the Contributing section from the Google Disclaimer section. I think that's much nicer!

ilyagr
ilyagr reviewed Oct 4, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
ilyagr
ilyagr reviewed Oct 4, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
ilyagr
ilyagr reviewed Oct 4, 2023
View reviewed changes
README.md Show resolved Hide resolved
@thoughtpolice thoughtpolice force-pushed the push-xptxxoluopqv branch 2 times, most recently from a06d26d to e19d3bc Compare October 5, 2023 19:50
martinvonz
martinvonz reviewed Oct 5, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@thoughtpolice
readme: tidy up the front matter a little
0a21112 
Summary: Just a small rework of the very top-level frontmatter. Now:

- Uses `<div>` to center things a little
- Adds top-level links to the new homepage, installation guide, and tutorial
- Reworks the disclaimer and 'Introduction' section. After all, a README should
first say what the project is! I think this reads much better.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
Change-Id: I2d92a21650afec0640add3741d4f20c5
@martinvonz
Copy link
Owner

LGTM. Feel free to merge. We can always adjust later if we notice anything.

@thoughtpolice thoughtpolice merged commit 4acdf72 into main Oct 7, 2023
15 checks passed
@thoughtpolice thoughtpolice deleted the push-xptxxoluopqv branch October 7, 2023 21:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ilyagr ilyagr ilyagr left review comments

@martinvonz martinvonz martinvonz approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@thoughtpolice @ilyagr @martinvonz