Adding additional information to the Ruby section to help contributors who are not used to Ruby.
Also explicitly stating that the project must be cloned and forked before using rbenv install $(cat .ruby-version)
Also adding a common error Nick and I encountered with a solution.
* Removing ElasticSearch Brew instructions
If you try to install brew as directed you get this Error:
Error: Calling Installation of elasticsearch-oss from a GitHub commit URL is disabled! Use 'brew extract elasticsearch-oss' to stable tap on GitHub instead.
Brew/ElasticSearch no longer allows you to tap as we previously have suggested in the doc. Also we can no longer grab the 7.5.2 version with brew.
We have decided to remove the instructions for now until we upgrade ElasticSearch if possible.
* Adding recommended changes.
Added back line 15 per Nicks recommendation (i.e. with rbenv: `rbenv install $(cat .ruby-version)`)
Line 65 updated to 7.5 or higher for Elasticsearch per Rhymes recommendation
~Forem requires a version of Elasticsearch 7.5 or higher to be running. We recommend version 7.5.2.~
Line 110 update:
Added back in the Homebrew instructions but updated commands to `install elastic/tap/elasticsearch-oss`
* Updating wording per Molly's suggestion
Updating "to be running " to "run" and adjusting line 64 to "Forem requires Elasticsearch 7.x to run. We recommend version 7.5.2."
* Adds a new admin setting for experience levels.
This is used in the post management UI to determine the range of experience. These values fallback to the ones we currently see in DEV, Total Newbies and Senior Devs. There is also a removal of the word coding when talking about experience level, since the context for each forem instance should be implied when referencing experience.
* Cleans up experience defaults
* Fixes instance_of usage
The `.env` file shouldn't live in the `/config` directory when it is created, but
currently, the `.env_sample` file lives within `/config`. This can be confusing and
cause ENV var issues if someone duplicates `.env_sample` and renames it to `.env`,
because none of their ENV variables will get picked up, since their `.env` file will
mistakenly end up in `/config`.
This change moves `.env_sample` out of `/config`, and updates the documentation/relevant
.yml files accordingly.
* Refactor:Remove ENVied Gem in Favor of Default application.yml
* Copy sample_application.yml for Travis
* Create .env_sample file, Warn of missing ENV variables, ignore .env file
* Use dotenv For ENV variables and create Rake Task to Populate
* Update docs to copy .env_sample file
* make application config a bit more resilient
* update more documentation and only initialize dotenv in dev and test
* Update doc code snippet types and refactor rake task and app config
* remove push defaults
* Make initializers more resilient, remove unused ENV from travis
* Exit new rake task if application.yml does not exist, include dotenv in docs
* Gitignore elasticsearch installations
* Add a note to explain that ES should be installed at the root level
Remove `/elasticsearch/*` from .gitignore as well!
* Update reference to home directory in mac + windows installation guides
* Rename all GitHub links from thepracticaldev/dev.to to forem/forem
* Use new site name
* Rename to Forem
* Rename more dev.to to forem
* Remove unnecessary redirects
* Rename DEV to Forem
* Use Forem instead of DEV for branding
* Use Forem instead of DEV for licensing
* Use seedling instead of DEV logo
* Upgrade to Ruby 2.7.0
* Upgrade Travis's Ruby as well
* Fix conflict
* Silence all Ruby 2.7 deprecation warnings in dev mode
* Silence dev and test unless CI
It was unclear to me that I explicitly needed Elasticsearch in order for certain tests to run locally. We should specify that in the docs. Also added a note about installing `wget`, which is required to install Elasticsearch in our docs.
* Improve format and clarity of the docs [ci skip]
While this change produces a lot of git noise by enacting what seems
like an arbitrary linewrap on most of the files in the documentation it
will result in better version control and tracking of the changes in the
documentation.
For example, as it currently stands, if one was to make a
PR to move a comma in a sentence because each paragraph in most of the
files is on a single line, that small change would look in the git
history like the author had modified the entire paragraph. In reality,
this author just moved a comma.
This change also includes a significant number of modifications to the
more article-esque docs. Many of these docs were written in a sort of
stream-of-conciousness and aren't as easy to read as they could be.
Hopefully this is the first of several readability changes. If we could
get these docs to a more accessible reading level, we would probably see
an increase in contributions. :)
* Delegate markdown wrapping to Prettier
* Add linewrapping explanation in the docs [ci skip]
* Add redis gem and client
* use keyword arguments in redis initializer
* check for REDISCLOUD_URL and fallback on REDIS_URL when connecting to redis
* dont parse Redis url in initializer
* Add specs for ArticleImageUploader
* Add specs for BadgeUploader
* Add specs for CoverImageUploader
* Add specs for ProfileImageUploader
* Refactor uploaders to inherit from BaseUploader
* Strip EXIF and GPS data from uploaded images
* Add ImageMagick to the docs
* Protect strip_exif
* Correct installation documentation
* Add stylized titles
* Add some changes to the getting started documentation
* Add changes for the backend guide
* Add changes for the design guide
* Add testing / Q&A guide improvements
* Minor fixes to contributing docs
* More improvements to the general doc
* Improvements for frontend guide
