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

Missing help pages: creating them and leaving them empty #308

Closed
mlep opened this issue Sep 10, 2020 · 4 comments
Closed

Missing help pages: creating them and leaving them empty #308

mlep opened this issue Sep 10, 2020 · 4 comments

Comments

@mlep
Copy link
Contributor

mlep commented Sep 10, 2020

I have identified some items that should have an help page:

  • Manage keywords
  • Edit preamble
  • Send as email
  • Preview style

(there may be other ones)

I propose to create the corresponding pages and leave them mostly empty, just with a message asking for contribution (see https://docs.jabref.org/collect/import )
To me it is a better approach than opening an issue here, and calling for their creation and writing because:

  • users will see the empty pages and may contribute directly (which user will come to the list of issues when an information is missing in the help pages?)
  • users can "vote" to show their disappointment, which give information about pages that should be completed more "urgently".

Please, let me know what you think.

@koppor
Copy link
Member

koppor commented Sep 10, 2020

We had the empty pages for years and no one new ever contributed.

I think, one approach could be to ask in the forum when someone writes on a specific topic. Then, one can coach the contributor.

Drive-by contribution for documentation unfortunately is very seldom.

@mlep mlep added the question label Sep 14, 2020
@mlep
Copy link
Contributor Author

mlep commented Sep 14, 2020

How to keep track of the missing help pages?
One issue with a list of all the identified missing help pages, or one issue per missing help page?

@Siedlerchr
Copy link
Member

I think one issue with a checklist of all pages makes it easier. Github will also show the "progress" of the issue then in the overview

@mlep
Copy link
Contributor Author

mlep commented Sep 14, 2020

OK, I will do so.

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

No branches or pull requests

3 participants