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

Add documentation for Springshare admin tasks #115

Open
25 tasks
VickieKarasic opened this issue Oct 28, 2024 · 0 comments
Open
25 tasks

Add documentation for Springshare admin tasks #115

VickieKarasic opened this issue Oct 28, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@VickieKarasic
Copy link
Contributor

VickieKarasic commented Oct 28, 2024

Introduction

We need to create documentation separate from Springshare's support docs(need to be logged into PUL LibApps to access) and from our user-facing docs on Confluence to outline the PUL-specific admin tasks that we perform in LibApps regularly.

Acceptance criteria

  • If there is no docs directory, create one.

  • Update an existing markdown document or add a new one in the docs directory.

  • It has introduction: Explains the goals and purpose of this documentation.

  • It has a step by step guide: Provides the exact steps to guide the user on how to do a task.

Additional acceptance criteria

  • It includes references: References any related resources that have assisted creating this documentation (links to other tickets, online articles etc.).

  • It includes workflow: Defines the steps in different environments (production, staging)

Even more acceptance criteria (see full list of PUL Springshare admin tasks)
  • LibApps

    • Creating accounts
    • Managing people's profile boxes
  • LibCal

    • Creating / editing locations and spaces
    • Creating / editing equipment
    • Editing library hours
    • Adding Zoom / Outlook integrations and checking integration status
    • Managing event calendars
  • LibGuides

    • Changing a Guide's owner
    • Update Look & Feel: guide templates, CSS/JS, headers/footers
    • Managing metadata and subjects/experts
    • Manage A-Z Databases List
  • LibAnswers

    • Forwarding to/from a service account
    • Creating queues
    • Deleting queues
  • LibWizard

@VickieKarasic VickieKarasic added the documentation Improvements or additions to documentation label Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant