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

Adding a versionintroduced variable to the frontmatter of connector pages #93

Closed
wants to merge 1 commit into from

Conversation

nate-double-u
Copy link
Contributor

Adding versionintroduced variable to frontmatter of connector pages, and updating the single.html file to display a "Since v0.0.0" message if it is set.

I don't know when each connector was introduced, so @sagikazarmark, @nabokihms please suggest one using the ```suggest notation for each of the files updated.

closes: #92

@nate-double-u
Copy link
Contributor Author

…le.html to show it.

Signed-off-by: Nate W <4453979+nate-double-u@users.noreply.github.com>
@nate-double-u
Copy link
Contributor Author

last force-push uses a sane if statement 😅

@nabokihms
Copy link
Member

I have a question. Do we want to change the version in this field if we changed the config of the connector, e.g., added a new option?
For example, the LDAP connector was added a long time ago, but in the release v2.23.0 its settings were rearranged. Thus, documentation on the website is only valid since dex v2.23.0.

@sagikazarmark
Copy link
Member

sagikazarmark commented Mar 16, 2021

Thanks @nate-double-u

I had the following in mind:

  • add a since version "badge" to pages
  • add "badges" within pages for new features

I think that would answer your question @nabokihms

Also, I don't think we have to add it to every page/connector.

@nate-double-u
Copy link
Contributor Author

So something that could be added (almost like a label) next to a line of copy or a paragraph?

@sagikazarmark
Copy link
Member

Either that, or something like this on the Symfony website: https://symfony.com/doc/current/routing.html

@nate-double-u
Copy link
Contributor Author

nate-double-u commented Mar 17, 2021

I understand now.

On their site, the following

.. versionadded:: 5.2

    The ability to use PHP attributes to configure routes was introduced in
    Symfony 5.2. Prior to this, Doctrine Annotations were the only way to
    annotate controller actions with routing configuration.

generates this
Screen Shot 2021-03-17 at 9 37 32 AM

I like that, but it's a bit more involved. I think I can piggyback off the note or warning annotations to achieve this -- you can see how they look live here. (We may want to pull them (notes and warnings) in from upstream as well, but that's probably a separate issue)

@sagikazarmark
Copy link
Member

Yeah, something like that would be great. I think we can create custom shortcodes/snippets in Hugo.

For example, a custom version admonition could accept a version as a parameter and use that internally to compare it to the current version in the config file. I don't know if Hugo templates has a semver function for that though.

This is still very much just an idea, so if there are other, better patterns out there, I'm all ears.

@sagikazarmark
Copy link
Member

@nate-double-u I started something very simple in #132

Do you think you could help finishing it (adding some style, etc)

@nate-double-u
Copy link
Contributor Author

Hi--I'm on vacation this week, but can take a look when I'm back 🙂

@nate-double-u
Copy link
Contributor Author

I'm going to close this PR. Now we've moved to Docsy we'd need a different implementation I think.

@nate-double-u nate-double-u deleted the 92-since-version branch April 13, 2024 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Since version x.y.z
3 participants