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.

Sign up for GitHub

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

Jump to bottom

Documentation #17

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Documentation #17

wants to merge 2 commits into from

Conversation

brynolv
Copy link
Contributor

@brynolv brynolv commented Mar 11, 2021 •
edited
Loading

Update documentation before needing to change it again in follow-up to #13 (#16), as it will need a separate development set-up.

Most of #11

@brynolv brynolv added the documentation Improvements or additions to documentation label Mar 11, 2021
mattiasgrenfeldt
mattiasgrenfeldt suggested changes Mar 11, 2021
View reviewed changes
Copy link
Contributor

@mattiasgrenfeldt mattiasgrenfeldt left a comment

Choose a reason for hiding this comment

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

This commit history is very confusing, can you please remake this PR but start from the current master branch. It looks like you have had an old documentation branch and then merged master into it or something. This PR should only need 1 commit.

@brynolv
Documentation
a44341d 
Squashed and rebased
@brynolv
Copy link
Contributor Author

brynolv commented Mar 11, 2021

This commit history is very confusing, can you please remake this PR but start from the current master branch. It looks like you have had an old documentation branch and then merged master into it or something. This PR should only need 1 commit.

Maybe since that's what happened 🙃 Rebased and Squashed, was fun to learn how-to.

DokID
DokID reviewed Mar 11, 2021
View reviewed changes
README.md Outdated
@@ -29,3 +29,17 @@ Required environment variables:
HODIS_HOST=https://hodis.datasektionen.se
LOGIN_HOST=https://login2.datasektionen.se
```

## Dependencies
Depends on login, hodis is refered to but not integral.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Depends on login, hodis is refered to but not integral.
Depends on login, hodis is referred to but not integral.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hodis is very integral. That is where zfinger fetches all information about users. Without hodis, zfinger would be pointless.

EDIT: @DokID I will forever write referer, this is HTTP's fault.

Copy link
Contributor Author

@brynolv brynolv Mar 25, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

@mattiasgrenfeldt Well... technically, zfinger works fine. Doesn't display anything, but it doesn't crash, the app itself works fine.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't agree. The point of zfinger is to look up people, that's the core functionality. Without hodis that functionality is impossible. So hodis is very much integral to zfinger.

mattiasgrenfeldt
mattiasgrenfeldt suggested changes Mar 11, 2021
View reviewed changes
README.md Outdated
@@ -29,3 +29,17 @@ Required environment variables:
HODIS_HOST=https://hodis.datasektionen.se
LOGIN_HOST=https://login2.datasektionen.se
```

## Dependencies
Depends on login, hodis is refered to but not integral.
Copy link
Contributor

Choose a reason for hiding this comment

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

Hodis is very integral. That is where zfinger fetches all information about users. Without hodis, zfinger would be pointless.

EDIT: @DokID I will forever write referer, this is HTTP's fault.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@brynolv
Reviews round 1
0427d2b 
Including:
refered -> referred
Less verbose PLs permissions
Clearer Dev-setup
Rewritten Production setup
mattiasgrenfeldt
mattiasgrenfeldt suggested changes Apr 13, 2021
View reviewed changes
Copy link
Contributor

@mattiasgrenfeldt mattiasgrenfeldt left a comment

Choose a reason for hiding this comment

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

Sorry for the extremely late review. You can press "Re-request review" in the reviewers tab next to my name.

It looks good except for the hodis part :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DokID DokID DokID left review comments

@mattiasgrenfeldt mattiasgrenfeldt mattiasgrenfeldt requested changes

@elmaxe elmaxe Awaiting requested review from elmaxe

Assignees

@brynolv brynolv

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@brynolv @DokID @mattiasgrenfeldt