Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs #995

Merged
merged 6 commits into from Jul 9, 2019
Merged

Update docs #995

merged 6 commits into from Jul 9, 2019

Conversation

alina-beck
Copy link
Collaborator

🍰 Pull request

  • fixes a few typos
  • replaces internal references with absolute links to make them work on GitBook
  • updates the "Edit this Documentation" part to work without the "Edit on GitHub" button
  • adds information on how to allow Apoc procedures on the Neo4j server
  • removes the line "This directory is not required, you can delete it if you don't want to use it." from all webapp docs (I assume they originate from the Nuxt.js templates but since we are using these directories and they can obviously not be removed I thought deleting the line might be less confusing for new contributors. Unless you have a good reason to keep it there?)

Issues

  • None

Todo

@codecov
Copy link

codecov bot commented Jul 8, 2019

Codecov Report

❗ No coverage uploaded for pull request base (master@ae2cf31). Click here to learn what that means.
The diff coverage is n/a.

Copy link
Contributor

@roschaefer roschaefer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I absolutely ❤️ it! Thank you so much! I have nothing to request except for one thing, see my suggestions below.

love

@alina-beck you have a new follower on Github. I will also add you to the team "Volunteers", so that will give you write permissions into our repositories. Write permissions means, you can push branches and you can also merge into master (after approving code review).

@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/user_account)
[Cucumber Features](./integration/user_account)

In this case it would be better to keep the relative path. Why? If you send in a PR and let's say you changed the referenced file and if a code reviewer would click on the link, she would be redirected to the master branch. You can try it out yourself by clicking on "Preview" and then click on the link.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, that's not ideal. The reason I changed it is that the relative paths are not working on GitBook. For some reason they add a /README.md to the end of the link and since there are no READMEs in the cypress/integrations folder you land on a 404 page...

Any idea how to get this working for both use cases?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No! In that case I'll approve this and merge. 👍

@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/user_profile)
[Cucumber Features](./integration/user_profile)

@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/post)
[Cucumber Features](./cypress/integration/post)

* 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Cucumber features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/notifications)
[Cucumber features](./cypress/integration/notifications)

@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/search)
[Cucumber Features](./cypress/integration/search)

@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/moderation)
[Cucumber Features](./cypress/integration/moderation)

@@ -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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Cucumber Features](https://github.com/Human-Connection/Human-Connection/tree/master/cypress/integration/internationalization)
[Cucumber Features](./cypress/integration/internationalization)

@roschaefer roschaefer merged commit 5342f0d into Human-Connection:master Jul 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants