1
0
mirror of https://github.com/quay/quay.git synced 2026-01-26 06:21:37 +03:00
Files
quay/static/js/services/documentation/documentation.service.ts
Joseph Schorr 0e56578f2a Update our documentation links to use a generated system (#336)
Will allow for us to easily update links over time and add new
ones.

Fixes https://issues.redhat.com/browse/PROJQUAY-575
2020-05-12 11:00:31 -04:00

13 lines
444 B
TypeScript

/**
* Service which provides helper methods for retrieving documentation links.
*/
export abstract class DocumentationService {
/**
* Returns the documentation URL for the given document ID.
* @param documentId The ID of the documentation to return.
* @param parameters Optional parameters for the document.
* @return url The documentation URL.
*/
public abstract getUrl(documentId: string, parameters?: object): string;
}