Commit graph

306 commits

Author SHA1 Message Date
Nick Taylor
a5ee17ade9
Added a link to a visual guide to Webpacker in the Webpacker documentation (#9665) 2020-08-07 10:25:36 -04:00
Ridhwana
fb2bcc076c
Base Documentation for Forem Site Configuration (#9664)
* feat: add some base docs for site configuration

* chore: update some urls

* chore: implement suggestions
2020-08-07 10:05:45 -04:00
Ben Halpern
52d15e79d8
Add initial language doc page (#9653) 2020-08-06 14:46:04 -04:00
Andy Zhao
48d9c28adb
Force redirect (#9622) 2020-08-03 19:40:31 -04:00
Andy Zhao
d949307364
Add redirects from docs.dev.to to docs.forem.com (#9618) 2020-08-03 18:55:33 -04:00
Josh Puetz
cda18d0aa4
[deploy] Move Admin interface paths (#9576)
* Move administrate to /resource_admin

* Test fixes

* Update docs
2020-08-03 08:49:23 -04: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
Stu Finn
95be4c6308
Update api_v0.yml (#9495)
Updated description with Forem placeholder text
2020-07-24 16:33:18 -04:00
Abenet Tamiru
eea93cc1d9
Add gitdocs as devDependency (#9463)
* Add gitdocs add a devDependency

* Update docs to use local gitdocs installation

* Apply suggestion

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

* Apply suggestion

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

* Fix other places where gitdocs is mentioned

* Revert to old Makefile

Co-authored-by: Nick Taylor <nick@iamdeveloper.com>
2020-07-24 13:48:36 +02:00
jkrsn98
b84f04baa5
API: add nullable to nullable fields in documentation (#9407)
* crossposted_at made nullable

* edited_at made nullable

* cover_image made nullable

* twitter_username made nullable

* github_username made nullable

* website_url made nullable

* user summary made nullable

* user location made nullable
2020-07-22 12:22:45 +02:00
Michael Kohl
2fe4a36271
[deploy] Add audit logs for credit card actions (#9416)
* Add AuditLog entries for credit card actions

* Update docs

* Update category and slug

* Update audit log example in docs
2020-07-22 08:23:42 +07:00
Michael Kohl
e3455ef921
Add curl alternatives for ES troubleshooting (#9414) 2020-07-21 13:24:28 +02:00
Piyush Suthar
e8b32c0e51
[deploy] Changed the Typo at "A Published article by path" (#9396) 2020-07-20 09:08:52 -04:00
Olawale Oyeyipo
c990f5d7d8
Fixed broken link, replaces file links with permalinks (#9334)
Co-authored-by: rhymes <rhymesete@gmail.com>
2020-07-16 07:41:07 -05:00
Olawale Oyeyipo
246660f120
Fixes javascript folder typo in webpacker documentation (#9329) 2020-07-16 09:35:00 +02:00
Andy Zhao
3b73038919
Update more Forem to DEV language (#9337)
* Update more Forem to DEV language

* Update readme with more Forem language

* Use Forem favicon, thanks @atsmith813!
2020-07-15 18:01:34 -04: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
rhymes
5a1c842b6f
API: add docs for get published article by path (#9261) 2020-07-13 15:33:30 +02: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
Ashik Paul
5094f6be9c
Fixed some minor typos (#9260) 2020-07-11 15:56:02 -05:00
Alex
bac350e877
[deploy] Add role and docs for user subscription liquid tag (#9170)
* Create new restriced_liquid_tag role

* Update role spec

* Use new role over admin

* Add documentation for user_subscription_liquid_tag

* Stub roles to help avoid flaky specs

* Add user approved liquid tags to edit view

* Remove "simply". Coding is hard, yo!

* Update liquid_help

* Update liquid help

* Update and refactor dashboard specs

* Refactor role check for liquid tag docs

* Improve docs wording
2020-07-08 14:07:53 -04: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
Danielle Heberling
4f31a8ac46
[deploy] Add Stackery liquid tag (#9063)
* Add stackery liquid tag

* Refactor stackery liquid tag

* Docs for stackery liquid tag

* Add stackery liquid tag tests

* Remove Github API check from stackery liquid tag

* Minor PR comment tweaks
2020-07-02 11:59:45 -04:00
Yash Dave
9b1b02b996
[deploy] fix blockquote render error windows docs (#9053) 2020-07-01 12:04:37 -04:00
Alex
347a4bbc75
[deploy] Add contexts and permissions to liquid tags (#8917)
* Make liquid tags adhere to context and permission

* Undo updates to all liquid tags and update error

* ACTUALLY update errors this time

* Typo

* Refactor error handling and add support for Comment

* Fix specs

* Code cleanup

* Prettify error message

* Add comment clarifying error

* parsed --> parse

* Use a policy for validating roles

* Fix pretty error message

* Return early if valid source

* Get rid of duplicate current_user

* Add comment to Pundit.authorize

* LiquidTagPolicy specs

* Update liquid tag docs

* Update docs

* Use parse_context argument for clarity

* Remove duplicate guard clause for VALID_ROLES

* Update docs
2020-06-30 14:53:18 -04:00
Jacob Herrington
8c4fd87599
Update maintainers documentation and contribution guides (#8939)
* Update contributing guide

In this change, I tried to simplify the language of the contributing
guide to make it more accessible and less wordy.

I also updated the information in a few places and fixed a couple of
typos.

* Remove table of contents

Since moving this doc to the docs site, our theme generates a ToC
automatically, hardcoding this one is redundant.

* Move the contributing guides

* Update maintainer documentation

This chnage updates the maintainers guide to include information on PR
reviews, deployments, and CI.

Housing this documentation here increases transparency with our
community.

* Edit with PR feedback

* Edit based on PR feedback
2020-06-30 09:11:59 +02:00
Yash Dave
83bc91b961
Fix rbenv install failing for windows docs (#8854) 2020-06-29 15:27:58 -04:00
Vaidehi Joshi
33222e430c
Link to @jessitron's blog post in our documentation guides (#8985) 2020-06-29 13:03:17 -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
Vaidehi Joshi
e49999ded0
Link to tracking docs from gitdocs sidebar (#8918) [deploy] 2020-06-25 13:14:08 -07:00
Vaidehi Joshi
dd6794a43b
Add documentation for tracking (#8914) [deploy]
* Add documentation for tracking

* Reword a sentence in backend tracking documentation
2020-06-25 11:47:51 -07:00
Vaidehi Joshi
d2ef01ecc2
Remove Percy (#8915)
We are no longer using the Percy service, so this code is not required anymore.
Removes the percy agent, the gem, and all references to Percy.snapshot and percy: true.
2020-06-25 11:19:58 -07:00
Jacob Herrington
d7768e00ff
Update self hosting docs with info on Forem (#8863)
We haven't updated this since announcing Forem. This isn't a
comprehensive change, but it links to some more information and is more
current that the old message.
2020-06-23 15:14:44 -04:00
Zach Attas
db468a6cfc
Adds ability to run spec not headlessly (#8844) 2020-06-23 08:37:37 -05:00
Nick Taylor
6bcdae3712
Configure eslint to use Preact linter rules (#8828) 2020-06-22 14:44:55 -04:00
Jacob Herrington
5b4f932713
[deploy] Move contributing documentation and document difficulty labels (#8775)
* Move contributing guide to the docs

I think it makes sense to address this information on the docs site, but
I also think the CONTRIBUTING.md convention is important.

In order to avoid duplicating the documentation for contributors, I
think it is a good idea to link people from the repo's contributing
guide to a document on the documentation site.

* Document difficulty labels

* Use Forem in place of DEV
2020-06-22 13:14:49 -05:00
Nick Taylor
653ec12300
Upgrade to Preact 10.4.4 (#8739)
Co-authored-by: Nick Taylor <nick@iamdeveloper.com>
Co-authored-by: Ridhwana <Ridhwana.Khan16@gmail.com>
2020-06-18 10:07:17 -04:00
Molly Struve
8ef9a27a97
Documentation: Document Status of Percy (#8424)
* Documention: Document Status of Percy

* Apply suggestions from code review

Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>

Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-06-12 11:07:07 +02:00
Molly Struve
2aeebcda5a
Documentation: Add More Knapsack Information to Docs (#8419)
Co-authored-by: Mac Siri <krairit.siri@gmail.com>
Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-06-11 17:50:32 -05:00
Molly Struve
4f831a836b
Flaky Spec Fix: Stub Requests to Elasticsearch For some js: true Specs (#8426)
Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-06-11 17:49:21 -05:00
Molly Struve
f647944046
[deploy] Spec Speedup: Use Knapsack to Run Parallel Builds (#8390) 2020-06-11 10:27:11 -05:00
Jacob Herrington
eb09d980ab
Update example code (#8397) 2020-06-11 13:16:03 +02:00
Molly Struve
14e50630fd
Flaky Spec Fix: Clear Elasticsearch Data For js: true Specs to Fix Server Errors (#8388)
Co-authored-by: Vaidehi Joshi <vaidehi.sj@gmail.com>
2020-06-10 14:12:19 -05:00
Andy Zhao
885e042d31
[deploy] New Feature: Mod Actions Panel (#7777)
* db

* Add an iframe to host mod actions menu

This iframe is probably the fastest way to get a working mod actions
menu without rewriting existing code. We may eventually re-write this,
but based on Ben's recommendation we are going to go with an iframe
because it gets us a working feature quickly and it seems to be serving
us well in other parts of the application.

* Add the mod actions menu button to articles

When the user is "trusted" they will see a small badge on the lower
right-hand side of the screen. Clicking the icon reveals the mod actions
menu.

* Add header to actions panel (#7395)

* Update iframe border

* Add 'Moderate Post' header and button

* Use inline SVG over <img src='svg'>

* Use Crayons variables for units

* Use flexbox to center chevron

* Add accidentally deleted positioning

* Add chevron-right.svg

* Use a partial for actions panel and revert /mod page

* Load actions panel in iframe and not /mod

* Style UpVote, DownVote and Vomit buttons (#7421)

* Add a iframe to host mod actions menu

* Up and Downvote Icons

* Starting with vomit button

* Completed UI; interactions pending

* Incorporated Andy changes; making mod action-panel

* space reactions away from header

* UI tweaks and corrections 1

* Fixing styles to match crayons

* choose pure white color css variable

* Add thumbs-up emoji; address Lisa comments

* Trying to fix reactions interactions

* remove clearThumbReactions function

Co-authored-by: jacobherrington <jacobherringtondeveloper@gmail.com>

* Add bottom layout for actions panel (#7501)

* WIP for Lisa

* Finalize mod actions bottom section

* Use showing instead of hidden for transition

* Add new optimized SVGs

* Fix weird height issues for actions panel

* Move hover styles below the cascade, yo

* Use margin-top for sticky footer over height: 100%

* Move initialize actions panel button to Webpack (#7506)

* Move actions panel JS code to webpack

* Refactor and use destructuring

Thanks @nickytonline!

Co-Authored-By: Nick Taylor <nick@iamdeveloper.com>

* Rename file

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

* Configure Experience Level options for Mod Action Panel (#7507)

* Add a iframe to host mod actions menu

* Click interactions (no toggle of dropdowns yet)

Co-authored-by: jacobherrington <jacobherringtondeveloper@gmail.com>

* Fix the iframe's path (#7509)

* Toggle the 'Set Experience Level' menu on button-click (#7529)

* Add a iframe to host mod actions menu

* Add set-exp dropdown functionality

* WIP: making exp level updates async

* Completes async implementation

* Fix controller for "actions_panel" and "/mod"

Co-authored-by: jacobherrington <jacobherringtondeveloper@gmail.com>

* Add close button interaction (#7552)

* Rename actions panel pack file

* Add close button toggle to actions panel

* DB update

* Move more code to Webpack and add conditional tag adjustments section (#7652)

* Move JS code to Webpack

* Clean up a few style issues

* Add styling for tag adjustments

* Add active/inactive functionality

* Add conditional rendering for tag adjustments section

* Add missing variable oops (#7673)

* update with upstream

* Add missing subtract svg (#7695)

* Create 'Flag User' modal (#7626)

* Add a iframe to host mod actions menu

* Starting task

* Phase 1

* Fix "Close Modal" icon

* Implement open modal

* Working on all "Close Modal" actions

* Almost-complete implementation

* Remove Abuse Report snackbar

* Delete unneeded JS code

* Remove "How does this work?" links

* Link to Community Moderation page

* Addressing code review corrections

* Update api call to use "request" method

* Make else path clearer in api call

Co-authored-by: jacobherrington <jacobherringtondeveloper@gmail.com>

* Mod Actions Panel: Prevent nonsensical reaction pairs (#7699)

* Still implementing

* Completed Implementation

* Address code review feednack; refactor "create" method

* Move scss variables to native-css (for ModPanel code only)

* Correct missing native css

* update to native-css again

* More sccs -> native-css fixes

* Adjust ModPanel Button position on mobile (#7744)

* Adjusted ModPanel position on mobile

* Better adjustment

* Fix phantom schema.rb changes

* Fix phantom schema.rb changes

* Finalize tag adjustments (#7740)

* Finalize tag adjustments and flow

* Fix logic for rendering adjust tags options

* Clean up alert response

* Rename user to trusted user

* Use new CSS variables

* Add/remove tag on article's tag section after adjusting

* Fix logic for admin tag input and some other niceties

* Final bug fixes mod panel (#7772)

* Use correct boolean statement

* Clear the value of the textarea not div

* Use the correct attribute

* Use actions panel for /mod page (#7775)

* Fix loading logic with tag adjust button conditional render

* Link to tag moderation for adjust tags section

* Use top over window.parent

Thanks @nickytonline!

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

* Use Webpack alias to import

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

* Use place-items shorthand over align-items + justify-content

Thanks @nickytonline!

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

* Fix typo for utilities

* Add new line to end of file

* Disable linter for use for top function

* Use align-items and justify-content center

* Update SVGs to spec

* Remove unnecessary height and use spacing units for open button

* Remove accidentally added comment

* Error handling when selecting reactions; optimize "reactions.each" loop

* Add comment about clearing innerHTML

* Revert schema back to master

* Use each since there should only be two reactions

* Fix typo oops

* Add missing height oops

* Return if there are no reactions to be destroyed

* Center path with GUI tool shrug

* chose more appropriate name for JS pack; rewrote api calls using async-await

* Rename variables and methods and check categories before clearing

* Use addSnackbarItem instead of hardcoded version

* Place articleModerationTools pack behind user_signed_in

* Correct omission

* Implement dynamic imports for ModPanel tools

* Implemented async/await; added snackbar message for null response use-case

* Fix the "/article/mod" page; make sure all reactions, vomit-user and exp-level working as expected

* Update language to reflect new UI

* Close the modal after the "Confirm Action" button is clicked

* Change text for Spam/Abuse button

* Fix schema to use with master

* Update schema to master again

* Use crayons button for actions panel button

* UI tweak to play nicer with site themes

* Make actions panel work for dev.to/mod

* Add snackbar for reactions

* Update how does this work links

* Add "thumbsup" reactions to logging

* Add thumbsup to categories

* Add external link icon

* Changes to reflect "Privileged" and not "Negative" reactions; spec changes pending

* Updated instance variable

* Starting to update the specs

* Update "thumbsup" points from 10 to 5

* Still working on both requests

* Embracing an easier implemantation (thanks Andy!)

* Add tests for actions panel

* Add some basic tests for actions panel

* Change to flag to admins

* Indicate that 'Reason for Tag adjust' is required

Co-authored-by: Mac Siri <krairit.siri@gmail.com>

* Rename negative_reactions to privileged

* Update rating level to use correct values

* Use a different display value than backend value

* Don't show adjust tags for trusted users

* Add specs for moderation_routes for admin and super_admin

Co-authored-by: Arit Amana <msarit@gmail.com>
Co-authored-by: jacobherrington <jacobherringtondeveloper@gmail.com>
Co-authored-by: Arit Amana <32520970+msarit@users.noreply.github.com>
Co-authored-by: Nick Taylor <nick@iamdeveloper.com>
Co-authored-by: Mac Siri <krairit.siri@gmail.com>
2020-06-08 13:24:18 -04:00
Dmitry Maksyoma
cc0254310c
Update docs to shine more light on bin/setup and bin/startup (#8290) 2020-06-05 12:21:53 -04:00
Jacob Herrington
4ebad8c4bc
Document the usage of Audit:Logger (#8284)
One of the DEV maintainers pointed out that our action logging mechanism
isn't documented anywhere. This add some context for that code!
2020-06-04 21:49:01 -05:00
Nick Taylor
eea508697a
Updated node debug flag to debug and break immediately (#8151) 2020-06-04 09:05:22 -04:00
Arit Amana
9961db3699
Small update to Test Coverage docs (#8257) 2020-06-04 12:01:12 +02:00
Fernando Valverde
fd639c2c15
pages:sync rake task for easier local coding of HTML Page (#8190)
* pages:bind rake task for local coding of HTML Page

* Tweaked task description

* Adds tests and enhancements to the task

* Replaces fixture with tmp file

* Adds check to avoid any side effects in production

* Removes clunky test

* Removes check for Test ENV (no longer in use)

* Adds reference to Pages in docs
2020-06-02 11:23:39 +02:00