From 888da86c6d3ee4490eb60deb70c6bbf8743877ab Mon Sep 17 00:00:00 2001 From: Alina Beck Date: Mon, 8 Jul 2019 18:03:54 +0200 Subject: [PATCH 1/6] update instructions to edit docs --- README.md | 2 +- edit-this-documentation.md | 11 ++--------- 2 files changed, 3 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ac7d2a024..411f7d842 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ Thank you lokalise for providing us with a premium account :raised_hands:. ## Developer Chat Join our friendly open-source community on [Discord](https://discord.gg/6ub73U3) :heart_eyes_cat: -Just introduce yourself at `#user-presentation` and mention `@@Mentor` to get you onboard :neckbeard: +Just introduce yourself at `#introduce-yourself` and mention `@@Mentor` to get you onboard :neckbeard: Check out the [contribution guideline](./CONTRIBUTING.md), too! diff --git a/edit-this-documentation.md b/edit-this-documentation.md index b01ace78f..cd83ac7a6 100644 --- a/edit-this-documentation.md +++ b/edit-this-documentation.md @@ -1,12 +1,6 @@ # Edit this Documentation -Go to the section and theme you want to change: On the left navigator. - -Click **Edit on GitHub** on the right. - -On the **Issue** tab you’ll find the open issues. Read what need to be done by clicking on the issue you like to fix. - -By going backwards in the browser **\(!\)**, again go to the **Code** tab. +Find the [**table of contents** for this documentation on GitHub](https://github.com/Human-Connection/Human-Connection/blob/master/SUMMARY.md) and navigate to the file you need to update. Click on the **edit pencil** on the right side directly above the text to edit this file on your fork of Human Connection \(HC\). @@ -14,7 +8,7 @@ You can see a preview of your changes by clicking the **Preview changes** tab as If you are ready, fill in the **Propose file change** at the end of the webpage. -After that you have to send your change to the HC basis with a pull request. Here make a comment which issue you have fixed. At least the number. +After that you have to send your change to the HC basis with a pull request. Here make a comment which issue you have fixed. (If you are working on one of our [open issues](https://github.com/Human-Connection/Human-Connection/issues) please include the number.) ## Markdown your documentation @@ -117,4 +111,3 @@ TODO: How to modify screenshots in Linux ... {% endhint %} {% endtab %} {% endtabs %} - From 4725f41a0dea92a570c74a67729516e122a053bc Mon Sep 17 00:00:00 2001 From: Alina Beck Date: Mon, 8 Jul 2019 18:26:22 +0200 Subject: [PATCH 2/6] update neo4j readme --- neo4j/README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/neo4j/README.md b/neo4j/README.md index 379a89eec..78c4bc62e 100644 --- a/neo4j/README.md +++ b/neo4j/README.md @@ -20,7 +20,7 @@ for an interactive cypher shell and a visualization of the graph. ## Installation without Docker -Install community edition of [Neo4J]() along with the plugin +Install the community edition of [Neo4j](https://neo4j.com/) along with the plugin [Apoc](https://github.com/neo4j-contrib/neo4j-apoc-procedures) on your system. To do so, go to [releases](https://neo4j.com/download-center/#releases), choose @@ -28,7 +28,13 @@ To do so, go to [releases](https://neo4j.com/download-center/#releases), choose and unpack the files. Download [Neo4j Apoc](https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases) -and drop the file into the `plugins` folder of the just extracted Neo4j-Server. +and drop the `.jar` file into the `plugins` folder of the just extracted Neo4j-Server. + +Then make sure to allow Apoc procedures by adding the following line to your Neo4j configuration \(`conf/neo4j.conf`\): + +``` +dbms.security.procedures.unrestricted=apoc.* +``` ### Alternatives @@ -59,6 +65,6 @@ $ cp .env.template .env $ ./db_setup.sh ``` -Otherwise if you don't have `cypher-shell` available, simply copy the cypher -statements [from the script](./neo4j/db_setup.sh) and paste the scripts into your -database [browser frontend](http://localhost:7474). +Otherwise, if you don't have `cypher-shell` available, copy the cypher +statements [from the `db_setup.sh` script](https://github.com/Human-Connection/Human-Connection/blob/master/neo4j/db_setup.sh) and paste the scripts into your +[database browser frontend](http://localhost:7474). From b2e68bf9df09ee43c4ca97e730b59bf0b6697155 Mon Sep 17 00:00:00 2001 From: Alina Beck Date: Mon, 8 Jul 2019 18:57:34 +0200 Subject: [PATCH 3/6] fix typo in webapp readme --- webapp/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/webapp/README.md b/webapp/README.md index ce27eca2f..604c7e6ba 100644 --- a/webapp/README.md +++ b/webapp/README.md @@ -41,4 +41,4 @@ All reusable Components \(for example avatar\) should be done inside the [Nitro- More information can be found here: [https://github.com/Human-Connection/Nitro-Styleguide](https://github.com/Human-Connection/Nitro-Styleguide) -If you need to change something in the styleguide and want to see the effects on the frontend immediately, then we have you covered. You need to clone the styleguide to the parent directory `../Nitro-Styleguide` and run `yarn && yarn run dev`. After that you run `yarn run dev:styleguide` instead of `yarn run dev` and you will see your changes reflected inside the fronten! +If you need to change something in the styleguide and want to see the effects on the frontend immediately, then we have you covered. You need to clone the styleguide to the parent directory `../Nitro-Styleguide` and run `yarn && yarn run dev`. After that you run `yarn run dev:styleguide` instead of `yarn run dev` and you will see your changes reflected inside the frontend! From 1f9f7e205a879e1809bd104b9d2ddb988a497b1e Mon Sep 17 00:00:00 2001 From: Alina Beck Date: Mon, 8 Jul 2019 19:10:21 +0200 Subject: [PATCH 4/6] remove "not required" line from webapp docs --- webapp/assets.md | 5 +---- webapp/components.md | 3 --- webapp/layouts.md | 3 --- webapp/middleware.md | 5 +---- webapp/plugins.md | 3 --- webapp/static.md | 5 ++--- webapp/store.md | 5 +---- 7 files changed, 5 insertions(+), 24 deletions(-) diff --git a/webapp/assets.md b/webapp/assets.md index 06786539d..6ac7dc388 100644 --- a/webapp/assets.md +++ b/webapp/assets.md @@ -1,8 +1,5 @@ # ASSETS -**This directory is not required, you can delete it if you don't want to use it.** - -This directory contains your un-compiled assets such as LESS, SASS, or JavaScript. +This directory contains your un-compiled assets such as LESS, SASS, or JavaScript – in our case SCSS styles. More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/assets#webpacked). - diff --git a/webapp/components.md b/webapp/components.md index be43ae454..92b3dd1fb 100644 --- a/webapp/components.md +++ b/webapp/components.md @@ -1,8 +1,5 @@ # COMPONENTS -**This directory is not required, you can delete it if you don't want to use it.** - The components directory contains your Vue.js Components. _Nuxt.js doesn't supercharge these components._ - diff --git a/webapp/layouts.md b/webapp/layouts.md index 300b5af89..a709d79fe 100644 --- a/webapp/layouts.md +++ b/webapp/layouts.md @@ -1,8 +1,5 @@ # LAYOUTS -**This directory is not required, you can delete it if you don't want to use it.** - This directory contains your Application Layouts. More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/views#layouts). - diff --git a/webapp/middleware.md b/webapp/middleware.md index 92c2ba10b..a899527e2 100644 --- a/webapp/middleware.md +++ b/webapp/middleware.md @@ -1,8 +1,5 @@ # MIDDLEWARE -**This directory is not required, you can delete it if you don't want to use it.** - -This directory contains your application middleware. The middleware lets you define custom function to be ran before rendering a page or a group of pages \(layouts\). +This directory contains our application middleware. The middleware lets you define custom functions to be ran before rendering a page or a group of pages \(layouts\). More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/routing#middleware). - diff --git a/webapp/plugins.md b/webapp/plugins.md index a54b05d0b..dc7b545f2 100644 --- a/webapp/plugins.md +++ b/webapp/plugins.md @@ -1,8 +1,5 @@ # PLUGINS -**This directory is not required, you can delete it if you don't want to use it.** - This directory contains your Javascript plugins that you want to run before mounting the root Vue.js application. More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/plugins). - diff --git a/webapp/static.md b/webapp/static.md index 748e8c5ed..db271e3a5 100644 --- a/webapp/static.md +++ b/webapp/static.md @@ -1,10 +1,9 @@ # STATIC -**This directory is not required, you can delete it if you don't want to use it.** - This directory contains your static files. Each file inside this directory is mapped to `/`. Example: `/static/robots.txt` is mapped as `/robots.txt`. -More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/assets#static). +We use it for images. +More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/assets#static). diff --git a/webapp/store.md b/webapp/store.md index 1310aa2da..6c8e3735c 100644 --- a/webapp/store.md +++ b/webapp/store.md @@ -1,10 +1,7 @@ # STORE -**This directory is not required, you can delete it if you don't want to use it.** - This directory contains your Vuex Store files. Vuex Store option is implemented in the Nuxt.js framework. -Creating a file in this directory activate the option in the framework automatically. +Creating a file in this directory activates the option in the framework automatically. More information about the usage of this directory in [the documentation](https://nuxtjs.org/guide/vuex-store). - From a1f28810b9f098fa06f792b9d4653f0384c3d2d1 Mon Sep 17 00:00:00 2001 From: Alina Beck Date: Mon, 8 Jul 2019 19:14:46 +0200 Subject: [PATCH 5/6] fix link in contributing readme --- CONTRIBUTING.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19aaf3301..0eb90a824 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,9 +4,9 @@ Thanks so much for thinking of contributing to the Human Connection project, we ## Getting Set Up -Instructions for how to install all the necessary software can be found in our [documentation](https://docs.human-connection.org/human-connection/) +Instructions for how to install all the necessary software can be found in our [documentation](https://docs.human-connection.org/human-connection/). -We recommend that new folks should ideally work together with an existing developer. Please join our discord instance to chat with developers or just ask them in tickets in [Zenhub](https://app.zenhub.com/workspaces/human-connection-nitro-5c0154ecc699f60fc92cf11f/boards?repos=152252353): +We recommend that new folks should ideally work together with an existing developer. Please join our [discord](https://discord.gg/6ub73U3) instance to chat with developers or just ask them in tickets in [Zenhub](https://app.zenhub.com/workspaces/human-connection-nitro-5c0154ecc699f60fc92cf11f/boards?repos=152252353): ![](https://dl.dropbox.com/s/vbmcihkduy9dhko/Screenshot%202019-01-03%2015.50.11.png?dl=0) @@ -17,7 +17,7 @@ Here are some general notes on our development flow: * Currently operating in two week sprints * We are using ZenHub to coordinate * estimating time per issue is the crucial feature of [Zenhub](https://app.zenhub.com/workspaces/human-connection-nitro-5c0154ecc699f60fc92cf11f) that Github does not have - * "up-for-grabs" links to [Github project](https://github.com/orgs/Human-Connection/projects/10?card_filter_query=label%3A"good+first+issue) + * "up-for-grabs" links to [Github project](https://github.com/Human-Connection/Human-Connection/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) * ordering on ZenHub not necessarily reflected on github projects * AgileVentures run open pairing sessions at 10:30am UTC each week on Tuesdays and Thursdays * Core team @@ -51,19 +51,19 @@ But what do we do when waiting for merge into master \(wanting to keep PRs small * solutions * 1\) put 2nd PR into branch that the first PR is hitting - but requires update after merging * 2\) prefer to leave exiting PR until it can be reviewed, and instead go and work on some other part of the codebase that is not impacted by the first PR - + ### Code Review -* Github setting in place - at least one review is required to merge +* Github setting in place - at least one review is required to merge - in principle anyone (who is not the PR owner) can review - but often it will be the core developers (Robert, Ulf, Greg, Wolfgang?) - once there is a review, and presuming no requested changes, PR opener can merge * CI/tests - - the CI needs to pass + - the CI needs to pass - linting <-- autofix? - tests (unit, feature) (backend, frontend) - codecoverage - + ## Notes question: when you want to pick a task - \(find out priority\) - is it in discord? is it in AV slack? --> Robert says you can always ask in discord - group channels are the best @@ -77,4 +77,3 @@ Matt makes point that new stories will have to be taken off the "New Issues" and Robert notes that everyone is invited to join the kickoff meetings Robert - difference between "important" \(creates a lot of value\) and "beginner friendly" \(easy to implement\) - From 4479431486551e55e3c401b2a8a67073053e8779 Mon Sep 17 00:00:00 2001 From: Alina Beck Date: Mon, 8 Jul 2019 19:27:30 +0200 Subject: [PATCH 6/6] replace internal links in features doc --- cypress/features.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/cypress/features.md b/cypress/features.md index eb8292c3b..3adfd8771 100644 --- a/cypress/features.md +++ b/cypress/features.md @@ -16,7 +16,7 @@ The following features will be implemented. This gets done in three steps: ### User Account -[Cucumber Features](./integration/user_account) +[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/user_account) * Sign-up * Agree to Data Privacy Statement @@ -34,7 +34,7 @@ The following features will be implemented. This gets done in three steps: ### User Profile -[Cucumber Features](./integration/user_profile) +[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/user_profile) * Upload and Change Avatar * Upload and Change Profile Picture @@ -59,7 +59,7 @@ The following features will be implemented. This gets done in three steps: ### Posts -[Cucumber Features](./integration/post/) +[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/post) * Creating Posts * Persistent Links @@ -78,13 +78,13 @@ The following features will be implemented. This gets done in three steps: ### Comments -* Creating Comments +* Creating Comments * Deleting Comments * Editing Comments * Upvote comments of others ### Notifications -[Cucumber features](./integration/notifications) +[Cucumber features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/notifications) * User @-mentionings * Notify authors for comments @@ -94,12 +94,12 @@ The following features will be implemented. This gets done in three steps: * Show Posts by Tiles * Show Posts as List -* Filter by Category \(Health and Wellbeing, Global Peace & Non-Violence, ...\) +* Filter by Category \(Health and Wellbeing, Global Peace & Non-Violence, ...\) * Filter by Mood \(Funny, Happy, Surprised, Cry, Angry, ...\) * Filter by Source \(Connections, Following, Individuals, Non-Profits, ...\) * Filter by Posts & Tools \(Post, Events, CanDos, ...\) * Filter by Format Type \(Text, Pictures, Video, ...\) -* Extended Filter \(Continent, Country, Language, ...\) +* Extended Filter \(Continent, Country, Language, ...\) * Sort Posts by Date * Sort Posts by Shouts * Sort Posts by most Comments @@ -116,7 +116,7 @@ The following features will be implemented. This gets done in three steps: ### Search -[Cucumber Features](./integration/search) +[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/search) * Search for Categories * Search for Tags @@ -186,13 +186,13 @@ The following features will be implemented. This gets done in three steps: ### More Info -Shows autmatically releated information for existing post. +Shows automatically related information for existing post. * Show related Posts * Show Pros and Cons * Show Bestlist * Show Votes -* Link to corresponding Chatroom +* Link to corresponding Chatroom ### Take Action @@ -237,7 +237,7 @@ Shows automatically related actions for existing post. ### Moderation -[Cucumber Features](./integration/moderation) +[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/moderation) * Report Button for users for doubtful Content * Moderator Panel @@ -262,7 +262,7 @@ Shows automatically related actions for existing post. ### Internationalization -[Cucumber Features](./integration/internationalization) +[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/internationalization) * Frontend UI * Backend Error Messages @@ -276,4 +276,3 @@ Shows automatically related actions for existing post. * Receiving Undo and Delete Activities for Articles and Notes * Serving Webfinger records and Actor Objects * Serving Followers, Following and Outbox collections -