docbrown/docs/backend/admin.md
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

30 lines
659 B
Markdown

---
title: Admin Panel
---
# Accessing the admin panel
There is an admin panel located at <http://localhost:3000/admin>.
To access the panel, you must be logged with a user with the `admin` role
activated.
To activate such a role, you can follow these instructions:
- open the Rails console
```shell
rails console
```
1. load the user object of for _bob_ (or whatever the username is)
```ruby
Loading development environment (Rails 5.2.3)
[1] pry(main)> user = User.find_by(username: "bob")
[2] pry(main)> user.add_role(:super_admin)
[3] pry(main)> user.save!
```
Now you'll be able to access the [administration
panel](http://localhost:3000/admin).