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

Missing documentation for services #847

Open
abjerner opened this Issue Jun 4, 2018 · 5 comments

Comments

Projects
None yet
5 participants
@abjerner
Copy link
Contributor

abjerner commented Jun 4, 2018

About half of the services are not documented - at least when looking here:

https://our.umbraco.org/documentation/Reference/Management/Services/

  • ApplicationTreeService
  • AuditService
  • ConsentService
  • ContentService
  • ContentTypeService
  • DataTypeService
  • DomainService
  • FileService
  • EntityService
  • ExternalLoginService
  • FileService
  • LocalizationService
  • MacroService
  • MediaService
  • MemberGroupService
  • MemberService
  • MemberTypeService
  • MigrationEntryService
  • NotificationService
  • PackagingService
  • PublicAccessService
  • RedirectUrlService
  • RelationService
  • SectionService
  • ServerRegistrationService
  • TagService
  • TaskService
  • TextService
  • UserService (work in progress : #604)

Just posting this for reference here. The ones in the list with a checkmark already have their own page(s) - the ones without the checkmark are missing. Should I create an issue for each missing service instead?

@marcemarc

This comment has been minimized.

Copy link
Contributor

marcemarc commented Jun 4, 2018

@abjerner I think it's fine for this to be a single issue, we have been in two minds when discussing the services, in that I think they should all be listed, their existence acknowledged! - and a short description of what they are and where they might be used, and any quirks, example of common usage if appropriate - but we sort of also feel we want to steer clear of duplicating the content generated in the API docs - eg https://our.umbraco.org/apidocs/csharp/api/Umbraco.Core.Services.ContentTypeService.html (but each service should have a clear signpost to the relevant api doc too) - just having each service, listed with it's own page would be a great start, so the checkbox list above is super useful

@Soundug

This comment has been minimized.

Copy link

Soundug commented Oct 26, 2018

@marcemarc Can I take this one?
I could add some services documentation.

@marcemarc

This comment has been minimized.

Copy link
Contributor

marcemarc commented Oct 27, 2018

@Soundug Yes, absolutely, we're trying to follow the pattern that @abjerner has established for the services - take a look at the domain service for example: https://our.umbraco.com/Documentation/Reference/Management/Services/

Essentially we are not trying to duplicate the auto generated api documentation eg https://our.umbraco.com/apidocs/csharp/api/Umbraco.Core.Services.DomainService.html

but kind of create a 'landing page' for each service, which links to the api documentation, and gives an overview of what the service does / is commonly used for, with samples on how to 'get a reference to it' etc

or at least first step is to get something existing for each service!

@abjerner

This comment has been minimized.

Copy link
Contributor

abjerner commented Oct 27, 2018

@Soundug Feel free to write here if you started adding documentation for some of the services. I planned on doing that for a least some of the missing services this weekend. I'll write here as well so we don't end up working on the same services ;)

@aredshaw

This comment has been minimized.

Copy link

aredshaw commented Dec 20, 2018

Are you using REST APIs? If so, I might be able to help.
What are the following?

  • The base path
  • Endpoints
  • All possible methods and parameters
  • An API Key (If required)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment