★ wanayoo — archive 1999 https://github.com/utPLSQL/utPLSQL/issues/890Nouvelle recherche | Portail wanayoo
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: Mark specific topics/features with "available since <version>" #890

Open
pesse opened this issue Apr 1, 2019 · 5 comments
Open
Assignees
Labels

Comments

@pesse
Copy link
Member

@pesse pesse commented Apr 1, 2019

utPLSQL grows rapidly and continues to get new, great features.
I think it would be very beneficial to have the documentation/userguide state which features are available since which version.

@pesse pesse self-assigned this Apr 1, 2019
@pesse pesse added the documentation label Apr 1, 2019
@pesse
Copy link
Member Author

@pesse pesse commented Apr 1, 2019

Maybe also add some indication of whether and how some features can be utilized with cli and SQLDeveloper plugIn.
@PhilippSalvisberg @jgebal thoughts?

@PhilippSalvisberg
Copy link
Member

@PhilippSalvisberg PhilippSalvisberg commented Apr 1, 2019

Not sure, if this is easy to understand. For example, the feature to compare cursors is available in the CLI and the SQLDev extension, but there is no directly related CLI nor SQLDev extension feature. In the CLI it does not make sense. In the SQLDev extension it could, e.g. to support building a test case.

@pesse
Copy link
Member Author

@pesse pesse commented Apr 1, 2019

Valid point - I thought more about the different run-possibilities.
I'll try an approach and request your feedback then :)

@jgebal
Copy link
Member

@jgebal jgebal commented Apr 1, 2019

How about versiom history document?
It's easier to maintain and gives really good visibility into what was changed/added.
I'm worried of polluting main documemt with available since.
utPLSQL has separate documentation publisjed with each version.
Maybe a "what's new in this release" document as part of documentation with links do doc page or issue (for bug fixes)?

@jgebal
Copy link
Member

@jgebal jgebal commented Apr 1, 2019

I wouldn't put "available since" into main doc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.