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

Update README Based on Roadmap. Remove Stale Information #151

Merged
merged 7 commits into from
Oct 29, 2019

Conversation

allella
Copy link
Contributor

@allella allella commented Oct 28, 2019

  • I have read Chapter's contributing guidelines.
  • My pull request has a descriptive title (not a vague title like Update README.md).
  • My pull request targets the master branch of Chapter.

Closes: Nothing

  • Removed Elasticsearch, since Quincy agreed with Elasticsearch as a hard requirement #32 that no advanced search tech is needed for the early going.
  • Removed the stale user stories and referenced the live Github MVP project and Post-release user stories #84 for post MVP.
  • Remove stale roadmap bullets and linked to the live Our Roadmap #47, which has an up-to-date list at the top.
  • Added suggested steps before creating a new user story issue.
  • Tweaked Docker link to be less verbose.

Copy link
Member

@vkWeb vkWeb left a comment

Choose a reason for hiding this comment

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

@allella Thank you for working on this. But I think your changes include a lot of links.

I would request you to revert to the old README.md by following these steps:

# Checkout PR's branch
$ git checkout fix/readme-roadmap-updates

# Revert to original state
$ git fetch upstream
$ git reset --hard upstream/master

Now you should make these changes to README.md:

  1. Remove elasticsearch from stack
  2. Keep TypeScript on stack not JavaScript/TypeScript
  3. Include roadmap issue link on the roadmap section
# Add files, commit and force push
$ git add .
$ git commit -m "fix: stack update"
$ git push origin fix/readme-roadmap-updates --force

README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@vkWeb
Copy link
Member

vkWeb commented Oct 29, 2019

@allella Please resolve the conflicts. Then remove JavaScript/TypeScript and replace it with just TypeScript there.

Thanks for your work on this my friend ;)

@allella allella merged commit ac73dc9 into freeCodeCamp:master Oct 29, 2019
@allella allella deleted the fix/readme-roadmap-updates branch October 29, 2019 02:52
@nik-john
Copy link
Contributor

@all-contributors please add @allella for doc

@allcontributors
Copy link
Contributor

@nik-john

I've put up a pull request to add @allella! 🎉

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

Successfully merging this pull request may close these issues.

4 participants