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

Improve useability of HOWTO examples #28

Open
patcon opened this issue Feb 9, 2022 · 0 comments
Open

Improve useability of HOWTO examples #28

patcon opened this issue Feb 9, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@patcon
Copy link
Member

patcon commented Feb 9, 2022

Right now, in the HOWTO.md doc, we have some expandable config examples:
https://github.com/g0v-network/domains/blob/main/docs/HOWTO.md#examples

Right now, these look like this (using the diff formatter):
Screen Shot 2022-02-09 at 1 19 32 PM

It's nice, because one diff can show changes in multiple files in the repo.

But as you can see in the above screenshot, highlighting also includes the + and - context lines.

It would be nice if there was a quicker, easier way to create a new PR. This could involve one or both of:

  1. Creating a hyperlink that initiates a stub PR and scaffolds out a new file, like Hypha does in the right-hand column of their meeting note directory.

  2. Use GitHub flavoured markdown to make the diffs more selectable using GitHub's permalink embed style. This is commonly used in pull requests and issues, but also works in any markdown docs within the repo. Example: https://github.com/patcon/test-github-markdown/

    ---
    '':
    - type: TXT
    values:
    # Who has admin for this domain
    - admin=patcon
    # Used for 301 redirect service below
    - 301 https://g0v.tw/
    - type: ALIAS
    value: 301.ronny.tw.

cc: Sam @therealitycorp

@patcon patcon added documentation Improvements or additions to documentation good first issue Good for newcomers and removed good first issue Good for newcomers labels Feb 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant