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

[Documentation] Move badges below H1 heading #11

Open
1 of 4 tasks
fivetran-joemarkiewicz opened this issue Nov 19, 2024 · 0 comments
Open
1 of 4 tasks

[Documentation] Move badges below H1 heading #11

fivetran-joemarkiewicz opened this issue Nov 19, 2024 · 0 comments
Labels
good first issue Good for newcomers issue:copycat type:enhancement New functionality or enhancement update_type:documentation Primary focus requires documentation updates

Comments

@fivetran-joemarkiewicz
Copy link
Collaborator

Copied from fivetran/dbt_tiktok_ads_source #24.

Is there an existing feature request for this?

  • I have searched the existing issues

Describe the Feature

We need to move the badges at the top of the README to be below the H1 heading. This is to be consistent with other popular README formats and also ensure there is no relevant information above the H1 heading. Additionally, we will need to adjust the orientation of the badges to be consistent with the rest of the README which is left-oriented.

How would you implement this feature?

Move the badge information below the H1 heading and change the <p align= to be "left".

For Example

In the before changes codeblock below, the H1 header (identified by a single #) needs to be moved to the very top. Then we must ensure everything within the <p> tag is below the H1 header, but before the first H2 heading (identified by a double ##).

Note: This example uses TikTok Ads Source. These changes should be applied consistently across all relevant repositories, using the repository-specific badge information.

Before Changes

<p align="center">
    <a alt="License"
        href="https://github.com/fivetran/dbt_tiktok_ads_source/blob/main/LICENSE">
        <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a>
    <a alt="dbt-core">
        <img src="https://img.shields.io/badge/dbt_Core™_version->=1.3.0_<2.0.0-orange.svg" /></a>
    <a alt="Maintained?">
        <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a>
    <a alt="PRs">
        <img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a>
</p>

# Tiktok Ads Source dbt Package ([Docs](https://fivetran.github.io/dbt_tiktok_ads_source/))
## What does this dbt package do?

After Changes

Notice the <p align="left"> update as well as the location of the badges between the H1 and H2 header with appropriate spacing.

# Tiktok Ads Source dbt Package ([Docs](https://fivetran.github.io/dbt_tiktok_ads_source/))

<p align="left">
    <a alt="License"
        href="https://github.com/fivetran/dbt_tiktok_ads_source/blob/main/LICENSE">
        <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a>
    <a alt="dbt-core">
        <img src="https://img.shields.io/badge/dbt_Core™_version->=1.3.0_<2.0.0-orange.svg" /></a>
    <a alt="Maintained?">
        <img src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" /></a>
    <a alt="PRs">
        <img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a>
</p>

## What does this dbt package do?

Are you interested in contributing this feature?

  • Yes.
  • Yes, but I will need assistance.
  • No.

Anything else?

No response

@fivetran-joemarkiewicz fivetran-joemarkiewicz added good first issue Good for newcomers type:enhancement New functionality or enhancement update_type:documentation Primary focus requires documentation updates issue:copycat labels Nov 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers issue:copycat type:enhancement New functionality or enhancement update_type:documentation Primary focus requires documentation updates
Projects
None yet
Development

No branches or pull requests

1 participant