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.

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

Refactoring of the user documentation #822

Open
8 of 23 tasks
dcoraboeuf opened this issue Nov 22, 2020 · 4 comments
Open
8 of 23 tasks

Refactoring of the user documentation #822

dcoraboeuf opened this issue Nov 22, 2020 · 4 comments
Assignees
Labels
documentation v4 Planned for version 4
Milestone

Comments

@dcoraboeuf
Copy link
Contributor

dcoraboeuf commented Nov 22, 2020

  • Quickstart
  • SaaS access
  • Installation
  • Setup
  • Authentication
  • Concepts
  • Authorizations
  • License management (pro only)
  • Feeding information
  • Integrations
  • Using the UI
  • Features (by categories)
  • Administration
  • GraphQL reference
  • REST reference
  • DSL reference
  • Metrics
  • Developing Ontrack
  • Architecture
  • Extending and extension points

Misc:

  • Quick start links from the README
  • Publish a version 4 in Docker Hub
  • Make the JDBC based security a default
@dcoraboeuf dcoraboeuf added documentation v4 Planned for version 4 beta labels Nov 22, 2020
@dcoraboeuf dcoraboeuf added this to the 4.0 milestone Nov 22, 2020
@dcoraboeuf dcoraboeuf self-assigned this Nov 22, 2020
dcoraboeuf added a commit that referenced this issue Nov 22, 2020
dcoraboeuf added a commit that referenced this issue Nov 22, 2020
@SansGuidon
Copy link
Contributor

Dont hesitate to add me as reviewer :-)

dcoraboeuf added a commit that referenced this issue Nov 22, 2020
dcoraboeuf added a commit that referenced this issue Nov 22, 2020
dcoraboeuf added a commit that referenced this issue Nov 22, 2020
dcoraboeuf added a commit that referenced this issue Nov 22, 2020
@dcoraboeuf
Copy link
Contributor Author

dcoraboeuf commented Nov 22, 2020 via email

@dcoraboeuf
Copy link
Contributor Author

dcoraboeuf commented Nov 22, 2020

@MorganGeek , if you're interested in reviewing the documentation (and in contributing), you can get the draft in the feature/822-documentation branch. You can build the doc locally by running:

./gradlew -Pdocumentation asciidoctor

Careful: starting from v4, Ontrack wants a JDK 11. I personally install it using SDKMan.

Upon generation, the doc is available at ontrack-docs/build/docs/asciidoc/index.html

It's also possible to generate the PDF using asciidoctorPdf.

@dcoraboeuf
Copy link
Contributor Author

In order to have a more streamlined delivery, I'll merge the new documentation skeleton into the existing documentation, moving the old one in the appendixes for now. This way, the old & new documentation will live together while I keep moving the old doc into the new one.

dcoraboeuf added a commit that referenced this issue Mar 13, 2021
dcoraboeuf added a commit that referenced this issue May 1, 2021
dcoraboeuf added a commit that referenced this issue May 1, 2021
@dcoraboeuf dcoraboeuf added the status:wip Issue being currently worked on label May 1, 2021
dcoraboeuf added a commit that referenced this issue May 1, 2021
dcoraboeuf added a commit that referenced this issue May 1, 2021
dcoraboeuf added a commit that referenced this issue May 1, 2021
@dcoraboeuf dcoraboeuf removed the beta label Aug 3, 2021
dcoraboeuf added a commit that referenced this issue Jan 4, 2022
@dcoraboeuf dcoraboeuf removed the status:wip Issue being currently worked on label Sep 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation v4 Planned for version 4
Projects
None yet
Development

No branches or pull requests

2 participants