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

Automate datasource docs for sourceUrl, releaseTimestamp #28948

Closed
rarkins opened this issue May 9, 2024 · 5 comments · Fixed by #29225
Closed

Automate datasource docs for sourceUrl, releaseTimestamp #28948

rarkins opened this issue May 9, 2024 · 5 comments · Fixed by #29225
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation

Comments

@rarkins
Copy link
Collaborator

rarkins commented May 9, 2024

Describe the proposed change(s).

Blocked by #28947

Once it is completed, we should automatically populate this information into datasource docs pages like https://docs.renovatebot.com/modules/datasource/cdnjs/

@rarkins rarkins added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation status:blocked Issue is blocked by another issue or external requirement labels May 9, 2024
@RahulGautamSingh
Copy link
Collaborator

image

Is this close to the expected design for the new fields? I feel like the notes should be highlighted in some manner but can decide how? I am thiking of putting them inside blockquote.

Any suggestions @HonkingGoose ?

@RahulGautamSingh RahulGautamSingh removed the status:blocked Issue is blocked by another issue or external requirement label May 22, 2024
@HonkingGoose
Copy link
Collaborator

Review of first draft

Thank you for the first draft of the design! Unfortunately it feels too much like a wall of text to me.

Layout problem not your fault

This is not your fault, as we have the same design problem in the current datasource docs. Because we have less fields in the current datasource docs, I did not see the problem before. 🙈

Example of current layout style

For example, here's the "code" for the AWS Machine Image Datasource, in Markdown:

# AWS Machine Image Datasource

**Identifier:** `aws-machine-image`

**Default versioning:** `aws-machine-image`

**Custom registry support:**

:heavy_check_mark: Custom registries are supported.

**Description:**

Rest of docs goes here.

We're using bold text as "headings". When there are four items, that works okay-ish. But now that you're adding more information in the sourceUrl and releaseTimestamp datasource docs, this strategy falls apart. With more information you really need a proper structure.

Directions to try

Try both of these, and see which we like best:

  • Use proper headings in a logical order
  • Use proper headings, and put basic information into table format

In any case, we should use real proper headings instead of bold text.

Example of proper headings

# AWS Machine Image Datasource

## Identifier

`aws-machine-image`

## Default versioning

`aws-machine-image`

## Custom registry support

Yes, custom registries are supported. // Note: I replaced the checkbox emoji with plain text

## Description

Rest of docs goes here.

Example of table layout

# AWS Machine Image Datasource

## Table of values

| Name                    | Value               | Notes |
| ----------------------- | ------------------- | ----- |
| Identifier              | `aws-machine-image` |       |
| Default versioning      | `aws-machine-image` |       |
| Custom registry support | Yes                 |       | // Note: I replaced the checkbox emoji with plain text

## Description

Rest of docs goes here.
Alternative table-layout with separate notes headings

If we are likely to need more than a single sentence as a note, we could try this layout:

# AWS Machine Image Datasource

## Table of values

| Name                    | Value               |
| ----------------------- | ------------------- |
| Identifier              | `aws-machine-image` |
| Default versioning      | `aws-machine-image` |
| Custom registry support | Yes                 | // Note: I replaced the checkbox emoji with plain text

### Notes about table items

#### Note about table item 1

Note for table item 1.
Another sentence about table item 1.
Final sentence about table item 1.

#### Note about table item 2

Note for table item 2.
Another sentence about table item 2.
Final sentence about table item 2.

#### Note about table item 3

Note for table item 3.
Another sentence about table item 3.
Final sentence about table item 3.

## Description

Rest of docs goes here.

Personal preference

I'm leaning towards the "proper headings and table layout, if we have short notes.

@HonkingGoose HonkingGoose added the status:requirements Full requirements are not yet known, so implementation should not be started label May 22, 2024
@RahulGautamSingh
Copy link
Collaborator

Here's the drafts:

Table only
image

Table followed by notes
image

@HonkingGoose
Copy link
Collaborator

I like the table with the notes in the table best.

The table with notes separate works also, but it takes up more space. And having a table with two columns feels a bit weird.

@RahulGautamSingh
Copy link
Collaborator

RahulGautamSingh commented May 23, 2024

While I am at it, I will also change the versioing docs to use proper headings. Since the changes are small, it's better to do it under this issue, rather than a separate PR/issue.

@RahulGautamSingh RahulGautamSingh removed the status:requirements Full requirements are not yet known, so implementation should not be started label May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants