Skip to content

Commit

Permalink
fixes thechangelog#191: WIP ask for feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
joebew42 committed Jan 29, 2018
1 parent 5fe5285 commit 4199ac4
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions scratchpad.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,32 @@
- Write a test that will document the avatar upload via a file upload input from the admin UI
- Write a test that will document the avatar upload via an image url input from the admin UI
- we have to validate that the Image URL is valid (e.g. it starts with an `http://` or an `https://`) this is because of [security concern](https://github.com/stavro/arc_ecto/blob/f9cc5730216f7f00e276da75c20f71372a38926f/CHANGELOG.md)
- update the person form of the admin so that we can specify an image url as avatar
- remove the tests from the person_controller side

## DOING

- open an issue with the details of the feature to implement and then make a pull request to start a conversation on that feature

## TODO

- update the person form of the admin so that we can specify an image url as avatar
- maybe we can use this [FakeServer](https://github.com/bernardolins/fake_server) to serve static content OR we can use [Cowboy](https://ninenines.eu/docs/en/cowboy/1.0/guide/static_handlers/#serve_one_file)
- Make the `scripts/setup` to work with systems different than macOS (maybe we can open a new issue about that)
- [important] add a changeset validation to the person Ecto schema so that the avatar field will accept only a valid URL value or a Plug.Upload structure (at the moment a user can specify a local path in the avatar image url input)


- [question] the `mix.lock` file is not committed (why? may can we open an issue about? or simply talk in the #dev of the slack changelog)

[Issue/Improve Readme]
- [development setup] Make the `scripts/setup` to work with systems different than macOS (maybe we can open a new issue about that)
- install yarn: `npm install -g yarn`
- maybe it could be useful to add a `Requirements` section? (e.g. the recommended elixir version, postgresql version, inotify-tools, etc)
- the command `yarn install` should be run in the `assets/` directory and not in the root directory of the project. (we have to fix the `scripts/setup`)
- the `mix.lock` file is not committed (why? may can we open an issue about? or simply talk in the #dev of the slack changelog)
- it is not documented how to configure a `PostgreSQL` instance, maybe can we use Docker? Or even document that we can easily run a postgresql instance with docker? Or we can put the default username and password to `config/dev.exs` and `config/test.exs`
- document `how to run tests`
- replace the deprecated command `mix phoenix.server` with new one `mix phx.server` in the documentation
- we can document the email to use to sign in as administrator for development purpose: `[email protected]` and the admin url `http://localhost:4000/admin`
- Open an issue by trying to propose a solution to upload and attach an image at the creation phase (at the moment we can upload an avatar only when the person exists, so we have to go through the update form)
- [README] it is not documented how to configure a `PostgreSQL` instance, maybe can we use Docker? Or even document that we can easily run a postgresql instance with docker? Or we can put the default username and password to `config/dev.exs` and `config/test.exs`
- [README] document `how to run tests`
- [README] replace the deprecated command `mix phoenix.server` with new one `mix phx.server` in the documentation
- [README] we can document the email to use to sign in as administrator for development purpose: `[email protected]` and the admin url `http://localhost:4000/admin`

- [Issue/Proposal] Open an issue by trying to propose a solution to upload and attach an image at the creation phase (at the moment we can upload an avatar only when the person exists, so we have to go through the update form)
- maybe it could be useful to decouple the `Identity` of a `Person` from tha `id` of the database (e.g. identity = hash(person.email))


- maybe we can use this [FakeServer](https://github.com/bernardolins/fake_server) to serve static content OR we can use [Cowboy](https://ninenines.eu/docs/en/cowboy/1.0/guide/static_handlers/#serve_one_file)

0 comments on commit 4199ac4

Please sign in to comment.