Skip to content
This repository has been archived by the owner on Sep 9, 2020. It is now read-only.

README: clarify deprecation and point to modules #2253

Merged
merged 1 commit into from
Sep 5, 2020

Conversation

mvdan
Copy link
Member

@mvdan mvdan commented Sep 4, 2020

@mvdan
Copy link
Member Author

mvdan commented Sep 4, 2020

FYI @myitcv @ALTree; had to create a PR since the master branch is locked against direct pushes.

@mvdan
Copy link
Member Author

mvdan commented Sep 4, 2020

Oh, the docs site is also in the master branch. I'll fix that here too.

Copy link
Member

@myitcv myitcv left a comment

Choose a reason for hiding this comment

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

LGTM with one suggestion.

README.md Outdated Show resolved Hide resolved
docs/introduction.md Outdated Show resolved Hide resolved
Copy link
Member

@ALTree ALTree left a comment

Choose a reason for hiding this comment

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

LGTM but I think the Feedback and Contributing sections should be
deleted from the README. Installing is still relevant since it's
possible to download an archived repository, but it won't be possible
to give feedback or contribute.

@mvdan
Copy link
Member Author

mvdan commented Sep 4, 2020

You both raise good points :) I'll update the commit.

Also, of course CI is required to merge, and it's broken... we'll have to wait for @andybons to grant one of us admin access to be able to push to master.

@ALTree
Copy link
Member

ALTree commented Sep 5, 2020

Indeed, the build is broken, so I've just disabled the hard requirement on the travis-ci check for merges. Now it should allow the merge even if the travis-ci build failed.

@mvdan mvdan force-pushed the readme-clarify-deprecation branch 2 times, most recently from 768d5d1 to bfc2b6d Compare September 5, 2020 13:32
@mvdan
Copy link
Member Author

mvdan commented Sep 5, 2020

I ended up with **NOTE:** instead of ** NOTE: **, because only the former would actually render as bold. I love markdown sometimes.

@mvdan
Copy link
Member Author

mvdan commented Sep 5, 2020

I think the Feedback and Contributing sections should be deleted from the README

I've also deleted both of those sections. Merging - thanks both for the reviews!

@mvdan mvdan merged commit f13583b into master Sep 5, 2020
@mvdan mvdan deleted the readme-clarify-deprecation branch September 5, 2020 13:35
@mvdan
Copy link
Member Author

mvdan commented Sep 5, 2020

It looks like actually updating the generated gh-pages branch is a manual process, last done in 2018. I'll try to figure out how to do it and push there.

@mvdan
Copy link
Member Author

mvdan commented Sep 5, 2020

Alright, done: 7afd7b6

All that I did boiled down to:

cd website
yarn
yarn build
GIT_USER=mvdan yarn publish-gh-pages

There are other changes applied to the generated pages aside from this PR, which I attribute to the long time it's been since anyone ran the tool. They all seem minor, though.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants