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

Update docs with new names #867

Merged
merged 3 commits into from
May 31, 2018
Merged

Update docs with new names #867

merged 3 commits into from
May 31, 2018

Conversation

benjamingeer
Copy link

@benjamingeer benjamingeer commented May 30, 2018 •
edited
Loading

  • KnarQL is now called Gravsearch.
  • The Knora API server is now just called Knora.
  • Restructure the docs somewhat as a result.
  • Correct a few errors and out-of-date things in the docs.

docs (webapi): Update docs with new names.
68e3108 
- KnarQL is now called Gravsearch.
- The Knora API server is now just called Knora.
- Restructure the docs somewhat as a result.
- Correct a few out-of-date things in the docs.
@benjamingeer benjamingeer added this to the v1.6.0 milestone May 30, 2018
@benjamingeer benjamingeer added the enhancement improve existing code or new feature label May 30, 2018
@benjamingeer benjamingeer mentioned this pull request May 30, 2018
Open
@benjamingeer benjamingeer changed the title Update docs with new names. Update docs with new names May 30, 2018
@benjamingeer benjamingeer requested a review from subotic May 30, 2018 15:47
@tobiasschweizer
Copy link
Contributor

I will review it tomorrow morning :-)

@tobiasschweizer
Copy link
Contributor

@benjamingeer f003b99 fixes the format documentation in typescript. Basically, the sample data is expected to be expanded (expanded prefixes).

If you want to document the format with the context object, this would have to be defined as a member of the interfaces.

@tobiasschweizer
Copy link
Contributor

I think in the tests we should build the docs with

typedoc --out target/site/api-v2 --readme none --name "Knora API V2 JSON-LD Format Documentation" --module commonjs src/api-v2

In case typescript throws an error, this means that the sample responses are not valid.

@benjamingeer
Copy link
Author

the sample data is expected to be expanded (expanded prefixes).

Thanks. Somehow I ran typedoc yesterday as you said and got no errors, but I've just tried again and got errors, so I don't know what happened.

I think in the tests we should build the docs with

That would be great. @subotic could Travis do this?

@tobiasschweizer
Copy link
Contributor

Thanks. Somehow I ran typedoc yesterday as you said and got no errors, but I've just tried again and got errors, so I don't know what happened.

Maybe you ran v1 by accident :-)

@benjamingeer
Copy link
Author

Maybe you ran v1 by accident

Probably!

@tobiasschweizer
Copy link
Contributor

Otherwise this PR looks fine to me.

@benjamingeer
Copy link
Author

Otherwise this PR looks fine to me.

Could you possibly approve it then so I can merge it?

tobiasschweizer
tobiasschweizer approved these changes May 31, 2018
View reviewed changes
Copy link
Contributor

@tobiasschweizer tobiasschweizer left a comment

Choose a reason for hiding this comment

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

Could you an issue for the format docs build on travis?

@benjamingeer benjamingeer merged commit 0f9800a into develop May 31, 2018
@benjamingeer benjamingeer deleted the wip/renaming branch May 31, 2018 07:55
@benjamingeer
Copy link
Author

Done. Thanks!

@subotic subotic modified the milestones: v1.6.0, v1.5.0 May 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tobiasschweizer tobiasschweizer tobiasschweizer approved these changes

@subotic subotic Awaiting requested review from subotic

Assignees

@benjamingeer benjamingeer

@tobiasschweizer tobiasschweizer

Labels
enhancement improve existing code or new feature
Projects
None yet
Milestone
v1.5.0
Development

Successfully merging this pull request may close these issues.
3 participants
@benjamingeer @tobiasschweizer @subotic