### Example Tutorial Step Source: https://gitlab.com/tgdp/templates/-/blob/main/tutorial/guide_tutorial.md An example of a complete tutorial step, demonstrating the use of explanatory text and a description of the outcome. ```text 1. Enter a name for your new repository. Good repository names are short and self-explanatory. Avoid repository names with three or more words. After you click "Create repository", GitHub creates your repository and the main page for the repository is displayed. ``` -------------------------------- ### Example Authentication Request Source: https://gitlab.com/tgdp/templates/-/blob/main/api-reference/template_api-reference.md An example of how to include authentication in an API request. Replace placeholders with your chosen authentication method and credentials. ```text {Provide an example request with {Basic | Digest | OAuth | others} authentication.} ``` -------------------------------- ### Example of a Step in Markdown Source: https://gitlab.com/tgdp/templates/-/blob/main/how-to/guide_how-to.md An example demonstrating how to structure a step within a documentation, including a task name, a brief description, and numbered sub-steps for actions. ```text Create pull request Pull requests are used to inform others of changes you have pushed to a branch in a repository. Once a pull request is opened, you can collaborate with reviewers and make changes before merging into the base branch. 1. To create a pull request, do the following: 1.1. Navigate to the main page of your repository. 1.2. Under your repository name, click **Pull requests**. By default, all open pull requests are displayed. ``` -------------------------------- ### Example Data Representation Source: https://gitlab.com/tgdp/templates/-/blob/main/api-reference/template_api-reference.md An example of the data structure used by the API. This should match the format specified in the data model, such as JSON or XML. ```text {Provide an example of the data representation in the format that your project use.} ``` -------------------------------- ### Tutorial Step with Substeps Source: https://gitlab.com/tgdp/templates/-/blob/main/tutorial/guide_tutorial.md Illustrates how to structure a primary step with indented substeps for more complex procedures. ```text 1. Create a new pull request. a. Navigate to the main page of your repository. b. Under your repository name, click **Pull requests**. By default, all open pull requests are displayed. c. .... ``` -------------------------------- ### Basic Step Structure Source: https://gitlab.com/tgdp/templates/-/blob/main/tutorial/guide_tutorial.md Template for organizing a single step in a tutorial, including optional explanatory text, code samples, and results. ```text 1. {Write the command here. Start with a verb.} {Optional: Explanatory text} {Optional: Code sample or screenshot that helps your users complete this step} {Optional: Result} ``` -------------------------------- ### Sample JSON Response for Task Creation Source: https://gitlab.com/tgdp/templates/-/blob/main/api-getting-started/template_api-getting-started.md This is a sample JSON response indicating a successful task creation. It includes details about the created task, such as its ID, workspace, name, assignee, and timestamps. ```json { "status": "success", "message": "Task created successfully.", "data": { "id": "TASK_GID", "workspace": "WORKSPACE_GID", "name": "Sample task", "assignee": { "id": "USER_GID", "name": "John Doe" }, "created_at": "2025-02-01T12:00:00Z", "updated_at": "2025-02-01T12:00:00Z", "due_date": null, "completed": false } } ```