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

Feature Request: New "Documentation" Issue Type #2108

Open
misilot opened this issue May 17, 2022 · 6 comments
Open

Feature Request: New "Documentation" Issue Type #2108

misilot opened this issue May 17, 2022 · 6 comments
Assignees
Labels
Type: feature request a proposal for a new feature in the software (should be justified by a ‘use case’)

Comments

@misilot
Copy link
Contributor

misilot commented May 17, 2022

Overview of feature request
Issue type that covers missing documentation

What kind of user is the feature intended for?
(Example user roles: Collections Manager, Developer, Systems Administrator, or User)
All?

What inspired the request?
Trying to submit a how to request because I couldn't find it in the documentation.

What existing behavior do you want changed?
N/A

Any brand new behavior do you want to add to Islandora?
N/A

Any related open or closed issues to this feature request?
N/A

@misilot misilot added the Type: feature request a proposal for a new feature in the software (should be justified by a ‘use case’) label May 17, 2022
@misilot
Copy link
Contributor Author

misilot commented May 18, 2022

From @ysuarez "Where do you think should belong"

@ysuarez
Copy link
Contributor

ysuarez commented May 19, 2022

I wonder if we should ask if this missing documentation is needed because they are using a particular Drupal theme, isladnora_defaults, Drupal install profile, etc. In case that the current docs are generally sufficient besides that.

Another way to approach this to just ask if the missing documentation applies solely for users that are using a particular theme/"defaults"/profile/etc.

This goes back to something that has been talked about at DIG, that our documentation (existing or new) should often mention if it is geared for those using a particular theme/"defaults"/profile/etc.

@ysuarez
Copy link
Contributor

ysuarez commented May 19, 2022

From @ysuarez "Where do you think should belong"

Added to where should the missing docs should belong, we may want to explicitly ask if it should be a brand new "page/section/part" or should it be part of a particular "page/section/part."

@ysuarez
Copy link
Contributor

ysuarez commented Jun 8, 2022

FYI @inikolaidis I just tried to create a new issues to see the template and it was not listed.

@inikolaidis
Copy link
Contributor

@ysuarez Just fixed this from @islandora-community and it should display now! The default health files placed in the Islandora/.github repo work well for all repositories that now have issue queues open and no existing .github folder within, but islandora/documentation's own .github folder overrides those from the islandora/.github defaults. I've copied the documentation issue template over so as not to mess with what's in islandora/documentation/.github

@islandora-community
Copy link
Contributor

See the commit to create docs-request.md in documentation repostory here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: feature request a proposal for a new feature in the software (should be justified by a ‘use case’)
Projects
None yet
Development

No branches or pull requests

4 participants