Commit graph

101 commits

Author SHA1 Message Date
zeotuan
6d45399a80
extend documentation on how to run cypres on wsl2 (#14393)
* fix analytic page have no back-to-dashboard button when user have no organization

* resolve conflict with main

* remove dump

* add test for back to dashboard button

* extend doc for windows installation

* remove unrelated file (fix checkout from wrong branch)

* Fix typo

Co-authored-by: rhymes <github@rhymes.dev>

* Fix typo

Co-authored-by: rhymes <github@rhymes.dev>

* Fix typo

Co-authored-by: rhymes <github@rhymes.dev>

Co-authored-by: rhymes <github@rhymes.dev>
2021-08-04 11:20:02 -06:00
okyanusoz
c0dd9dc40e
Update imgproxy.md (#14084) 2021-06-28 09:10:36 -05:00
Andrew Bone
ba5e55ae44
Update rbenv-doctor location in docs (#13803)
* Update with best practices

* Remove useCallback

* Update app/javascript/shared/components/useKeyboardShortcuts.js

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>

* Fill out JSDoc

* Follow Prettier rules

* Resolve conflict

* 📝 Update rbenv-doctor location

Co-authored-by: Suzanne Aitchison <suzanne@forem.com>
2021-05-19 08:59:22 -06:00
Madza
cac7fd1c55
Update GitPod setup description (#13709) 2021-05-12 10:30:42 +02:00
Alex
393ba00221
Remove Elasticsearch ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ ✂️ (#13606)
* Attempt number 1

* Fix rack_attack specs

* Fix users_searches_users spec

* Fix display_users_search_spec

* Fix comment typo

* Remove search:destroy task from cypress

* Remove port 9300 from gitpod

* Stub response in attack_spec
2021-05-03 11:09:45 -04:00
Christina
bcbeb66c98
Update Ruby Section and Add Additional Error (#12669)
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.
2021-02-12 10:45:34 -06:00
Jacob Herrington
8a5db7b877
Fix broken doc links (#12615) 2021-02-09 08:20:14 -06:00
rhymes
cb27662e8a
Recommend Redis 6 for Forem self installation (#11473) 2020-11-18 17:05:00 +01:00
Karen Dickenson
7047b01671
11163 - documentation - installation/containers (#11192)
* Reordered and reworded .env setup for clarification

* One more clarification
2020-11-05 10:03:18 -05:00
Alexis Hope
7a6ad7b83a
Docs: Fix docker-compose instructions (#11274)
* docs: minor typos

* docs: restore stand up terminology

* docs: typo fix
2020-11-05 09:12:40 -05:00
ludwiczakpawel
44466532dd
Z-index cleanups (#11157)
* tooltips 1.0.1

* tooltips 1.0.1

* cleanup css

* few more fixes

* fix
2020-10-30 16:03:23 +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
Christina
473c2ccb8d
Removing ElasticSearch Brew instructions (#10370)
* 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."
2020-10-29 14:25:56 -06:00
Mac Siri
540bc1fd84
[deploy] Add Imgproxy docs (#11104)
Co-authored-by: Molly Struve <mollylbs@gmail.com>
Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-10-29 09:03:55 -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
Ben Halpern
36ccfd55dd
[deploy] Add Twitter and GitHub keys to SiteConfig (#9899)
* Add Twitter and GitHub keys to SiteConfig

* Change docs

* Add notice about not taking affect right away
2020-08-20 15:58:15 -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
Molly Struve
8b8ee0a00e
Documentation: Vault Docs (#8936)
Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-06-29 09:33:52 -05:00
Joe Doss
aa49cb1cfe
Bugfix for #7663 and refactor of container setup (#7747)
* Move from Alpine Linux to Fedora Linux.

This changes the base container image away from Alpine Linux to
Fedora Linux to address some musl libc issues with some of our gems.

It also moved the main file to a Containerfile and symlinks the Dockerfile
to it. This makes our container setup less Docker-centric as Linux users
most likely will be using Podman as their container runtime.

Lastly, it moves the WORKDIR from /usr/src/app to /opt/apps/devto.
The Linux FHS states that /opt is the spot for Optional application
software packages and /usr/src is for kernel source code.

https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard

/opt Optional application software packages
/usr/src Source code, e.g., the kernel source code with its header files.

Also, if SELinux becomes a thing in our future, moving this makes it
easier to manage contexts out of /opt rather than /usr/src.

* Adjust the Containerfile a bit to add some missing packages, make it
more generic and move env vars to the docker-compose.

* Move the Dockerfile to a symlink to the Containerfile.

We need to be able to support more than just Docker for a container
runtime. Moving everything to a Containerfile and symlinking the
Dockerfile helps users run runtimes such as Podman.

* Add in new entrypoint files and fix the app path in docker-entrypoint.sh

* Refactor the docker-compose.yml file so it doesn't build the main
application container three times in a row. We can use the same
container for web, webpacker, and sidekiq.

Also make the volume names very explicit on what their contents and add
in SELinux context support with :Z

* Fix ELASTICSEARCH_URL.

* Remove the absolute path on ip binary and add in iproute to Containerfile.

* Symlink the Dockerfile to Containerfile and add in a container-compose.yml file
for usage with podman-compose. We are waiting for this issue to get resolved

https://github.com/containers/libpod/issues/6153

and for podman-compose to mature a bit more. A user using podman-compose can use

podman-compose -f container-compose.yml

to launch the DEV container stack with Podman.

* Update the .gitignore file to reflect the new container volumes.

* Fix the entrypoint script on the Containerfile and clean up a bunch of things.

* Rework the Containerfile to prep it to run as a non-root user. We have to wait
for this issue to get fixed:

https://github.com/containers/libpod/issues/6153

for Linux users and then we can uncomment the USER line so we are running Rails
as a non-root user. :toot:

* This reworks the compose files so each task that is needed to start the app has
a correct wait command with dockerize. It also adds in containers for doing
yarn and bundle things for development. Since we mount the code directory inside
the container we lose our pre-containerized gems and node_modules.

This means users can run:

Linux
podman-compose -f container-compose.yml up

Mac
docker-compose up

and it should correctly build the app stack with containers!

* Clean up old container related things.

* Add in some container pre-reqs and my name to the "Core team" section! :toot:

* Adjust the seed and sidekiq compose entries so they do not use the web entrypoint
and set the REDIS_URL and REDIS_SESSIONS_URL env vars for seed.

Add in some echos to the entrypoint.sh.

Also set docker-compose to use :delegated on mount points to speed things up.

https://docs.docker.com/storage/bind-mounts/#configure-mount-consistency-for-macos

* Just call yarn install --dev on the yarn container.

* Update documentation to support Docker and Podman as Container Engines and
move the page from docker to containers to reflect the fact not all users run
their containers via Docker.

There are dozens of us... DOZENS!

* Set --local on bundle config so it just impacts this Ruby app.

* Renamed bin/docker-setup to bin/container-setup to reflect the fact that that
we can use Podman as a container engine. I also refactored it so it does some
basic pre-flight checks for docker and docker-compose or podman and
podman-compose to make sure users have a container engine installed.

* Set cache_all_platforms true for bundler.

* Bump docker-compose dockerize -timeout to 45min for slower macOS hardware.

* Move to the consolidated app_initializer:setup rake task for bootstrapping the
app.

* Update docs/installation/readme.md
2020-05-28 12:11:51 -05:00
Molly Struve
182faa0289
[deploy] Consolidate Setup Tasks to a Single Rake Task (#8065) 2020-05-27 11:59:07 -05: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
b7a29c7144
Make DATABASE_URL_TEST optional (#7604)
* Make DATABASE_URL_TEST optional

* Add documentation

* Update wording
2020-04-30 11:19:16 +02: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
briwa
604e76dd88
refactor(docker-setup): use bash instead of ruby (#6935)
* refactor(docker-setup): use bash instead of ruby

* refactor: use a proper header

* refactor: bash -> sh
2020-03-30 10:13:52 +02:00
briwa
09f0773c18
refactor(docker): move redis env config to docker (#6936)
instead of in config/application.yml
2020-03-30 10:48:38 +07:00
Michael Kohl
9b12080478
A docker_setup script (#6827) 2020-03-27 18:48:32 -04:00
Michael Kohl
8b5e66ca0e
Docker fixes (#6803)
* Try out parallel Travis builds

* Add more Bundler options

* Appease the spec gods

I don't think we actually need Timecop.freeze in this spec

* Try inlining factories

* Make sure the time has actually changed

* Add CodeClimate coverage for parallel build

* Explicitly list jobs, don't rely on matrix expansion

* Merge master and move storybook to after_script

* Add missing environment variable

* Remove old cc-test-reporter config

* Move yarn build-storybook back to script, remove conditional coverage upload

* Update yarn constraint and Docker docs

Co-authored-by: rhymes <rhymesete@gmail.com>
2020-03-24 13:15:04 -04:00
Mac Siri
5a9cf514d1
Remove redundant yarn step for Docker (#6572) 2020-03-11 11:56:31 -04:00
Vaidehi Joshi
273dbff099
Add explicit note about cding into Elasticsearch before starting (#6503) [deploy] 2020-03-06 10:34:46 -08: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
rhymes
7b6417ca78
Add documentation for how to install ES from homebrew on macOS (#6387)
* Add documentation for how to install ES from brew

* A bit clearer

* Update docs/installation/mac.md

Co-Authored-By: Ridhwana <Ridhwana.Khan16@gmail.com>

* Update docs/installation/mac.md

Co-Authored-By: Ridhwana <Ridhwana.Khan16@gmail.com>

* Move testing section after installation

* Update docs/installation/mac.md

Co-Authored-By: Vaidehi Joshi <vaidehi.sj@gmail.com>

* Update docs/installation/mac.md

Co-Authored-By: Vaidehi Joshi <vaidehi.sj@gmail.com>

Co-authored-by: Ridhwana <Ridhwana.Khan16@gmail.com>
Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-03-02 15:33:33 +01:00