Skip to content
This repository has been archived by the owner on Nov 17, 2020. It is now read-only.

Versionning selector #46

Open
Thomas-lhuillier opened this issue Jun 29, 2018 · 5 comments
Open

Versionning selector #46

Thomas-lhuillier opened this issue Jun 29, 2018 · 5 comments
Projects
Milestone

Comments

@Thomas-lhuillier
Copy link

Hello,

Any idea how a versioning selector could be implemented in Stylemark ?
I was thinking about something like on symfony docs.

screen shot 2018-06-29 at 09 40 15

Anyway, very good project. Keep up the good work.

@mpetrovich
Copy link
Owner

That’s a great question and a challenging one. In your mind, what would the ideal workflow be in terms of creating new versions?

@Thomas-lhuillier
Copy link
Author

Thomas-lhuillier commented Jun 29, 2018

Maybe we could have a new parameter defined in the header block like this :

---
name: component name
category: category name
version: 1.0
---

Then we could rely on this to create a version selector, and hide/reveal pages from the navigation bar.

This seems like a 'simple' approach, but it forces us to have the docs for all versions in the same place.

@mpetrovich
Copy link
Owner

What should the workflow be for updating to a new version, say 2.0 in this example?

@Thomas-lhuillier
Copy link
Author

Thomas-lhuillier commented Jun 29, 2018

For the case of dedicated markdown files it seems manageable to add new files for each version.
But for docs inside source code I don't know :/ duplicating comment blocks wouldn't be suited.

@mpetrovich mpetrovich added this to the 3.x milestone Jun 29, 2018
@Thomas-lhuillier
Copy link
Author

Thomas-lhuillier commented Jun 30, 2018

You were originally asking me about "ideal" workflow. I would say ideal workflow for versioning would be to use git branches/tags to handle multiple versions.
Teams/individuals often maintain multiple git branches and/or tags to handle versions in their original projects.
Finding a solution that rely on this (or in which we could plug git branches) would be perfect.

@mpetrovich mpetrovich removed this from the 3.x milestone Oct 23, 2018
@mpetrovich mpetrovich added this to the v4.0 milestone Dec 30, 2019
@mpetrovich mpetrovich added this to To do in v4.0 Dec 30, 2019
@mpetrovich mpetrovich reopened this Apr 30, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
No open projects
v4.0
  
To do
Development

No branches or pull requests

2 participants