Procházet zdrojové kódy

Merge pull request #381 from igorshubovych/remove-index-mention-from-contributing

Remove index mention from Contributing.md guidelines
Waldir Pimenta před 9 roky
rodič
revize
3d78b46ada
2 změnil soubory, kde provedl 5 přidání a 1 odebrání
  1. 1 1
      CONTRIBUTING.md
  2. 4 0
      Makefile

+ 1 - 1
CONTRIBUTING.md

@@ -9,7 +9,7 @@ Contribution are most welcome! All `tldr` pages are stored in Markdown right her
 
 ## Setup
 
-When setting up a brand new fork, run `make setup` to install the git pre-commit hook that will rebuild the index every time you commit your changes. You can also rebuild it manually by running `make index`. The script requires Ruby to run. Make sure you have the index in place as we will need it as part of your commit in order to pull in your changes.
+When setting up a brand new fork, run `make setup` to install the git pre-commit hook that will check errors in your changes with Markdown linter.
 
 ## Guidelines
 

+ 4 - 0
Makefile

@@ -3,6 +3,10 @@ default: lint
 all: setup index
 
 index:
+	@echo "WARNING!"
+	@echo "Index rebuilding is deprecated."
+	@echo "You should not do it, unless you understand why you doing this."
+	@echo
 	@TLDRHOME=`pwd` ./scripts/build_index.rb
 	@echo "Index rebuilt."