Commit graph

46 commits

Author SHA1 Message Date
rhymes
cb27662e8a
Recommend Redis 6 for Forem self installation (#11473) 2020-11-18 17:05:00 +01:00
Yih Yang
24a4a421e1
removed envied docs (#11160)
* removed envied docs

* updated linux.md and windows.md

* removed envied documentation from windows.md and linux.md
2020-10-30 10:38:38 -04:00
Alexis Moody
f4a10e4a44
[deploy] Adds a new admin setting for experience levels. (#10870)
* 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
2020-10-16 12:40:25 -06:00
Karin Hendrikse
270c044698
replace Envfile with env_sample and reference env file in auth docs (#10864)
Co-authored-by: khendrikse <k.hendrikse@youngcapital.nl>
2020-10-16 00:09:16 -05:00
Sabarish Rajamohan
e1b3844dfa
[deploy] Updated minimum requirements for local installation on Windows (#10513)
* Updated minimum requirements for local installation on Windows

* Added reference links to WSL 2 support in docs
2020-10-01 11:36:15 -04:00
Kevin McGinn
3bce753303
[Documentation] Improvements to Windows installation & startup docs (#10243)
* fix elasticsearch tgz filename in windows docs

* add prereqs to running bin/startup in windows docs

* add tip for Sidekiq errors in app startup docs
2020-09-09 18:19:16 -04:00
Vaidehi Joshi
1531c182cc
Move .env_sample out of /config directory (#9868)
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.
2020-08-19 18:18:30 +02:00
Molly Struve
0a64ac067b
[deploy] Remove ENVied Gem, Use dotenv Take 2 (#9767) 2020-08-14 12:20:47 -05:00
rhymes
e727956640
Revert "[deploy] Refactor:Remove ENVied Gem, Use dotenv Instead for Test and Development (#9621)" (#9757)
This reverts commit 1be8c72206.
2020-08-12 13:28:38 -04:00
Molly Struve
1be8c72206
[deploy] Refactor:Remove ENVied Gem, Use dotenv Instead for Test and Development (#9621)
* 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
2020-08-12 11:01:38 -04:00
Vaidehi Joshi
c075c496fb
Update docs with details on where to install Elasticsearch (#9670) [deploy]
* 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
2020-08-10 11:37:14 -07:00
Yash Dave
691f0448fc
Update Windows Installation docs to WSL 2 (#9573)
* update wsl installation information

* update postgreSQL installation for windows to wsl2

* update elasticsearch instructions for wsl2

* Update imagemagick installation for wsl2

* implement suggestions
- fix typo
- provide elasticsearch install commands rathen than links
- switch wsl steps to numbered
2020-07-30 15:02:42 -05:00
Andy Zhao
955bdcb2bc
Update docs with Forem instead of dev.to (#9316)
* 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
2020-07-15 13:29:11 -04:00
Molly Struve
fde4d3f189
Update Docs, Travis, and Containers to Use Postgres 11 (#9232)
* Update Docs and Containers to Use Postgres 11<, Bump Travis to 10

* Update installation docs as well

Co-authored-by: rhymes <rhymes@hey.com>
2020-07-13 15:09:26 +02:00
Yash Dave
26e3bb96ab
fix node install windows docs (#9070)
* fix node install windows docs
- add nvm installation
- switch yarn to install without node
- add `nvm install` post clone

* improve sentence formation for nvm installation

Co-authored-by: Nick Taylor <nick@iamdeveloper.com>

* Remove "Node.js" out of codeblocks

* improve language clarity

Co-authored-by: Nick Taylor <nick@iamdeveloper.com>
2020-07-02 15:46:36 -05:00
Jacob Herrington
0c08a63622
Standardize capitalization of JavaScript (#9080)
* Standardize capitalization of JavaScript

* Reword links to alternate JS guides
2020-07-02 15:44:38 -05:00
Yash Dave
9b1b02b996
[deploy] fix blockquote render error windows docs (#9053) 2020-07-01 12:04:37 -04:00
Yash Dave
83bc91b961
Fix rbenv install failing for windows docs (#8854) 2020-06-29 15:27:58 -04:00
Dmitry Maksyoma
44d48a5585
Adapt dev env to use remote box (#7742) 2020-05-13 10:21:00 -04:00
rhymes
e6f9841bca
Update Windows 10 installation docs (#7647) 2020-05-01 13:49:44 -04:00
Mac Siri
2ea320a245
Support docker-selenium (#7583)
* Support use of selenium-docker

* Apply suggestion

* Add documentation
2020-04-30 11:07:45 +02:00
Molly Struve
4c779be2ed
[deploy] Remove ALL Algolia Code (#7577) 2020-04-29 10:11:57 -05:00
rhymes
5c17e5c25d
Upgrade Ruby to 2.7.1 (#7097) [deploy]
* Upgrade Ruby to 2.7.1

* Use explicit version in Dockerfile

* Fix docs Gemfile
2020-04-06 18:21:50 +02:00
rhymes
6bede2a92b
Upgrade to Ruby 2.7.0 (#5281) [deploy]
* 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
2020-04-03 17:36:19 +02:00
rhymes
6f3a8bb407
Bump min version of PostgreSQL (#6443) 2020-03-04 16:40:49 +01:00
rhymes
d95d78671f
Update ES docs for min/max versions and macOS brew (#6441)
* Update ES docs for min/max versions and macOS brew

* Clarify why we need to install the non default version
2020-03-04 14:28:12 +01:00
Molly Struve
0409722899
Introduce Elasticsearch to DEV env (#5762) [deploy] 2020-02-03 09:12:05 -05:00
Jacob Herrington
7d0aeeefe5 Improve the clarity of the docs and fix Prettier config (#4899)
* 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]
2019-11-26 08:40:53 -05:00
Molly Struve
69e35dc1b3 Add Redis gem and Create RedisClient (#4582)
* 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
2019-10-30 10:32:59 -04:00
rhymes
8989a52aba Strip EXIF and GPS data from uploaded images (#4450)
* 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
2019-10-24 16:35:10 -04:00
rhymes
89476fae08 Upgrade Ruby to 2.6.5 (#4451) 2019-10-17 09:34:31 -04:00
Joshua Tzucker
b61db22dc5 [DOC] Update PostgreSQL docs (#4345) [ci skip] 2019-10-10 10:28:17 -04:00
Yash Dave
0a9dc547d0 Updates Docs -> Installation -> Windows -> Possible error messages (#3804)
Adds solution for the command 'bin/setup' failing while trying to install
'cld-0.8.0' due to absence of 'aclocal-1.10' and 'automake-1.10'. Provides
commands to install 'automake-1.10' from 'ftp.gnu.org' which fixes the problem.

Signed-off-by: Amorpheuz <mail2ypd@gmail.com>
2019-08-22 15:56:40 -04:00
Mac Siri
de2bf910fd
Update doc on statement_timeout errors (#3248) [ci skip] 2019-06-20 13:36:40 -04:00
Mazen Touati
d5869a3b99 Add a possible error resolution for windows installation (#3178) 2019-06-16 00:45:26 -04:00
rhymes
56e13d00f0 Upgrade Ruby to 2.6.3 (#2649) 2019-05-02 12:06:18 -04:00
rhymes
9210f6793b Improvements on dev docs (#2616)
* 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
2019-04-29 18:54:29 -04:00
Andrew Brown
30dcb23169 #2507 - refactor GitDocs documentation (#2595)
* #2507 - refactor GitDocs documentation

* #2507 - fix grammar and spelling errors
2019-04-29 10:08:22 -04:00
Abraham Williams
fdd18e6bb1 Simplify development setup (#2143) 2019-03-25 12:53:39 -04:00
rhymes
dd6372012d Upgrade Ruby to 2.6.1 (#1711)
* Upgrade Ruby to 2.6.1

Ruby 2.6.1 contains a fix for Net::HTTP

* Add 2.6.1 to .ruby-version as well

* Add 2.6.1 to Travis CI as well
2019-02-06 16:48:28 -04:00
Vinicius Stock
0725b85e50 Upgrade to Ruby 2.6.0 (#1482)
* Upgrade to Ruby 2.6.0

* Change Ruby version in guides and in travis

* Upgrade Rubocop

* Change Rubocop version for code climate

* Update .codeclimate.yml

* Update badge
2019-01-09 15:59:38 -05:00
Anna Buyanova
48dbe55d05 Remove database.yml from the repo (#1162)
* Remove database.yml file from the repo, fixes #478

* Update dev.to docs

* Switch to the bullet list for the database.yml docs
2018-11-27 16:42:10 -05:00
Raphael Miedl
8d8f30d600 Fix typos and wording in installation docs. (#1108) 2018-11-12 18:11:58 -05:00
rhymes
3c61c026c5 Upgrade Ruby to 2.5.3 (#996) 2018-10-24 13:31:59 -04:00
Nathan Sebhastian
625c4374a3 Create Windows installation doc (#671) 2018-10-01 15:15:46 -04:00
Mac Siri
7e88a3b57f Expend installation docs (#366)
* Update Travis's Slack config

* Fix styling

* Update prerequisites

* Update prerequisites

* Update README

* Expand installation docs

* Specify minimum Postgres version [ci skip]

* Change specified PostgreSQL version

* Update netlify.toml

* Update schema

* Update algolia links [ci skip]

* Update installation docs

* Remove TODO

* Update installation path/title

* Update top level installation guide

* Change installations directory name

* Rename installations to installation in docs

* Fix headline typo

* Add liquid tags and adjust main readme
2018-08-16 15:52:56 -04:00