Skip to content

Commit b2a5df2

Browse files
mark-dcemjgiarlojcoyneatztdonohue
authored
Merge wiki (#2859)
* Initial Home page containing info about HyBox's multi-tenant domain model * Updated Home (markdown) * Updated Home (markdown) * Created SSH to an aws machine (markdown) * Created Rails Console on an Elastic Beanstalk machine (markdown) * Updated Rails Console on an Elastic Beanstalk machine (markdown) * Updated Rails Console on an Elastic Beanstalk machine (markdown) * Updated Rails Console on an Elastic Beanstalk machine (markdown) * Created Update the cloudformation deploy (markdown) * Updated Update the cloudformation deploy (markdown) * Updated SSH to an aws machine (markdown) * Updated SSH to an aws machine (markdown) * Created Import from purl (markdown) * Created ActiveJob on SQS (markdown) * Updated ActiveJob on SQS (markdown) * Updated ActiveJob on SQS (markdown) * Created ActiveJob with tenants (markdown) * Updated ActiveJob on SQS (markdown) * Created Cleaning out bad data (markdown) * Updated Cleaning out bad data (markdown) * Updated Cleaning out bad data (markdown) * Updated Cleaning out bad data (markdown) * Updated Cleaning out bad data (markdown) * Updated Cleaning out bad data (markdown) * minimal info for running tests * Updated Import from purl (markdown) * Updated Import from purl (markdown) * Updated Import from purl (markdown) * Updated Cleaning out bad data (markdown) * server won't find solr w/o RAILS_ENV=test * Updated SSH to an aws machine (markdown) * Updated SSH to an aws machine (markdown) * Updated SSH to an aws machine (markdown) * Updated SSH to an aws machine (markdown) * Updated SSH to an aws machine (markdown) * Updated SSH to an aws machine (markdown) * Updated SSH to an aws machine (markdown) * Updated SSH to AWS demo stack (markdown) * Updated SSH to AWS demo stack (markdown) * pfctl -d * Updated SSH to AWS demo stack (markdown) * Updated Rails Console on an Elastic Beanstalk machine (markdown) * Update with instructions on granting superadmin rights. Cleanup instructions slightly. * Update with instructions on using lvh.me instead of /etc/hosts * Note about superadmin login & getting to tenant info * Updated Home (markdown) * Updated SSH to AWS demo stack (markdown) * Updated SSH to AWS demo stack (markdown) * Updated SSH to AWS demo stack (markdown) * Updated SSH to AWS demo stack (markdown) * Updated SSH to AWS demo stack (markdown) * Updated SSH to AWS demo stack (markdown) * added db console example and reoganized * Enhanced description of the Multi-tenant domain model * Fix grammar * Add config/settings.yml examples * Updated Rails Console on an Elastic Beanstalk machine (markdown) * Additional information about postrgres/redis; Remove sidekiq startup * Updated SSH to AWS demo stack (markdown) * Updated SSH to AWS demo stack (markdown) * Updated SSH to AWS demo stack (markdown) * Revert 9f0fe04...98fd3bd on Hyku Development Guide * Updated Hyku Development Guide (markdown) * Updated Hyku Development Guide (markdown) * Updated Hyku Development Guide (markdown) * Updated Hyku Development Guide (markdown) * Updated Hyku Development Guide (markdown) * Created How Broke Is It? (Production data debugging scratchpad) (markdown) * Add link to guide on Rails console / DB access * ``` * Updated How Broke Is It? (Production data debugging scratchpad) (markdown) * Updated Rails Console and DB Console on an Elastic Beanstalk machine (markdown) * Updated Rails Console and DB Console on an Elastic Beanstalk machine (markdown) * Minor note: Sites exist on tenant (not globally) * Clarify how to create a global user for development * Updated Home (markdown) * Updated Hyku Development Guide (markdown) * osx firewall * Created Hyku on Docker (markdown) * Updated Hyku on Docker (markdown) * Updated Hyku on Docker (markdown) * Updated Hyku on Docker (markdown) * Updated Hyku on Docker (markdown) * Updated Hyku on Docker (markdown) * Updated Hyku on Docker (markdown) * Updated Hyku on Docker (markdown) * Created Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Details on how to get to Command Prompt in Windows * Updated Hyku Development Guide (markdown) * Updated Home (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Update the cloudformation deploy (markdown) * Created Give tenant user admin role (markdown) * Created Create super-admin user (markdown) * Updated Home (markdown) * Add notes about setup for a production env on a laptop * Updated Hyku Development Guide (markdown) * Created Apache and Passenger tips (markdown) * Updated Apache and Passenger tips (markdown) * Created Multi-tenant domain model (markdown) * Created Using account-switching in development (markdown) * Updated Using account switching in development (markdown) * Updated Multi tenant domain model (markdown) * Updated Home (markdown) * Updated Home (markdown) * Updated Update the cloudformation deploy (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Running on docker (markdown) * Updated Home (markdown) * Created Set email addresses (markdown) * Created View Solr and Zookeeper dashboards in AWS (markdown) * Updated Home (markdown) * Updated View Solr and Zookeeper dashboards in AWS (markdown) * Updated View Solr and Zookeeper dashboards in AWS (markdown) * Updated View Solr and Zookeeper dashboards in AWS (markdown) * live s3 bucket * Updated Hyku Development Guide (markdown) * Updated Rails Console and DB Console on an Elastic Beanstalk machine (markdown) * Updated Rails Console and DB Console on an Elastic Beanstalk machine (markdown) * Updated Create super admin user (markdown) * Updated Import from purl (markdown) * Created Run rake task on all or selected tenants (markdown) * Updated Run rake task on all or selected tenants (markdown) * Updated Home (markdown) * Update with UI instructions * Updated Home (markdown) * Created Managing who can create new tenants (markdown) * Updated Managing who can create new tenants (markdown) * Updated Create super admin user (markdown) * Updated Running on docker (markdown) * Created Versioning - Draft (markdown) * Updated Home (markdown) * Created Super Admin vs Admin (markdown) * Add out of date warning blockquote * Add information for managing repository themes * updating title * add selecting custom themes to management section * Add information for creating and adding custom themes * Adding link to creating custom themes page * Updated Home (markdown) * Created Groups with Roles Feature (markdown) * Updated Groups with Roles Feature (markdown) * Updated Groups with Roles Feature (markdown) * Updated Groups with Roles Feature (markdown) * See this commit for context: 787083a * Updated Groups with Roles Feature (markdown) * fix link, genericize * consolidate data creation instructions * add documentation contributed by Hyku for Consortia * add solr configset creation instructions * update renamed rake task * Updated Groups with Roles Feature (markdown) * Updated Home (markdown) * reorganize sections * add "Deposit and edit access to a single Collection (and Admin Set)" example use case * rename example collection name to be more generic * add ability matrix breakdown for example use case * make ability matrix more generic and update table of contents * ability matrix incomplete disclaimer * Created Hyku Test Plan (markdown) * Updated Hyku Test Plan (markdown) * Updated Hyku Test Plan (markdown) * Updated Hyku Test Plan (markdown) * Created Updating Hyku 6 with Hyrax 5 Developer Notes (markdown) * Updated Updating Hyku 6 with Hyrax 5 Developer Notes (markdown) * Updated Updating Hyku 6 with Hyrax 5 Developer Notes (markdown) * 📚 Adding ACL considerations * 📚 Working on User Inteface Considerations * 📚 Updating notes on our approach * 📚 Adding info about internal resource * 📚 Adding Goddess documentation * add docs for Bulkrax field mappings in Hyku * Updated Home (markdown) * Created Valkyrie Migration (markdown) * Updated Valkyrie Migration (markdown) * Updated Valkyrie Migration (markdown) * Updated Valkyrie Migration (markdown) * Updated Valkyrie Migration (markdown) * Updated Home (markdown) * Remove obsolete AWS Sandbox management links * Destroyed ActiveJob on SQS (markdown) * Destroyed View Solr and Zookeeper dashboards in AWS (markdown) * Destroyed Update the cloudformation deploy (markdown) * Destroyed Rails Console and DB Console on an Elastic Beanstalk machine (markdown) * Destroyed SSH to AWS demo stack (markdown) * Move pages into a structure that can be merged into /docs We want to move relevant pages into the /docs director of the main Hyku repostiory. This makes it easier to version the documentation with code releases. This commit moves the source files into a structure that allows us to merge them into the main repo without conflicts while retaining the full wiki commit history. * Remove obsolete pilot and related documentation * Remove pages now living in Confluence Documentation relating to administration of tenants and content now lives in the Samvera Wiki on Confluence: https://samvera.atlassian.net/wiki/spaces/hyku/pages/3185311833/2.2+Guidance+for+Hyku+Repository+Administrators --------- Co-authored-by: Michael J. Giarlo <mjgiarlo@stanford.edu> Co-authored-by: Justin Coyne <jcoyne@justincoyne.com> Co-authored-by: Joe Atzberger <ohiocore@gmail.com> Co-authored-by: Tim Donohue <tdonohue@duraspace.org> Co-authored-by: Darren L. Weber, Ph.D <dweber.consulting@gmail.com> Co-authored-by: Bill Branan <bbranan@duraspace.org> Co-authored-by: Rob Kaufman <rob@notch8.com> Co-authored-by: kellyChex <chess.kelly@gmail.com> Co-authored-by: Chris Colvard <chris.colvard@gmail.com> Co-authored-by: Lea Ann Bradford <leaann@notch8.com> Co-authored-by: Benjamin Kiah Stroud <32469930+bkiahstroud@users.noreply.github.com> Co-authored-by: Jill Peterson <84697174+jillpe@users.noreply.github.com> Co-authored-by: Kirk Wang <k3wang@gmail.com> Co-authored-by: Jeremy Friesen <jeremy.n.friesen@gmail.com> Co-authored-by: LaRita Robinson <laritakr@users.noreply.github.com> Co-authored-by: Sarah Proctor <42073869+sjproctor@users.noreply.github.com>
1 parent e070cc3 commit b2a5df2

11 files changed

Lines changed: 2012 additions & 0 deletions
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
## How does activejob work with tenants
2+
the `config/initializers/apartment_activejob.rb` initializer includes `ActiveJobTenant` onto `ActiveJob::Base`. This module adds a `tenant` key on the queue messages and calls `Apartment::Tenant.switch` around the `perform` method.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
## Adding a New Custom Theme
2+
Developers can add new home page themes and show page themes to an application with four steps:
3+
* Add the basic theme information
4+
* Add any view/template overrides
5+
* Add the custom CSS for the theme
6+
* Add a wireframe to render on the theme select page
7+
8+
### Adding theme information
9+
Basic theme information for home page themes is added to `config/home_themes.yml` and theme information for the show page themes is added to `config/show_themes.yml`.
10+
11+
Example code (for a theme named "Magnificent"):
12+
```
13+
magnificent:
14+
banner_image: true
15+
featured_researcher: true
16+
home_page_text: false
17+
marketing_text: true
18+
name: Magnificent
19+
notes: This theme is recommended for institutional repositories and is designed to highlight a featured researcher.
20+
```
21+
22+
### Adding view/template overrides
23+
Your theme will probably require changes to the default Hyku templates. Hyku will look for your theme templates in a specific location. Any template overrides should be placed inside a folder that shares your theme name (magnificent, in this example). For example, if you are overriding the `_home_content.html.erb` template, you should place your version in `app/views/themes/magnificent/hyrax/homepage/_home_content.html.erb`.
24+
25+
The more complex your theme is, the more likely you will have several template overrides.
26+
27+
### Adding custom CSS
28+
Your theme will probably require custom CSS. Hyku will look for your theme CSS file in a specific location, and it expects the name of the file to match your theme name (magnificent, in this example). Your theme stylesheet should be a .SCSS file and should be located at `app/assets/stylesheets/themes/magnificent.scss.`
29+
30+
Your stylesheet needs to wrap all of your theme styles inside of a class that shares your theme name. Hyku will add a class with your theme name to the body tag, so this will ensure that your theme styles will only apply when your theme is active.
31+
32+
For example:
33+
```
34+
.magnificent {
35+
img {
36+
border-radius: 50%;
37+
border: .5px solid #ccc;
38+
padding: 5px;
39+
}
40+
}
41+
```
42+
43+
### Theme wireframe
44+
Your theme requires a wireframe so that users can see a preview of what your theme will look like when selecting it in the Admin Dashboard Appearance panel.
45+
46+
Your wireframe should be added to the asset pipeline, inside of a folder named after your theme. Your wireframe must be a .jpg file, and it must be named after your theme. For example, if your theme name is "Magnificent", you would place your wireframe at `app/assets/images/themes/magnificent/magnificent.jpg`.
47+
48+

docs/wiki/Home.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
Welcome to the Hyku development wiki!
2+
3+
* [Development](#development)
4+
* [Multi-tenancy](#multi-tenancy)
5+
* [Amazon Web Services](#amazon-web-services)
6+
* [Cleanup](#cleanup)
7+
* [Docker](#docker)
8+
* [Custom Themes](#custom-themes)
9+
* [Management](#management)
10+
11+
## Development
12+
* [[Hyku Development Guide]]
13+
14+
## Multi-tenancy
15+
* [[Multi tenant domain model]]
16+
* [[Managing who can create new tenants]]
17+
* [[Using account switching in development]]
18+
* [[ActiveJob with tenants]]
19+
* [[Run rake task on all or selected tenants]]
20+
21+
## Cleanup
22+
* [[Cleaning out bad data]]
23+
* [[How Broke Is It? (Production data debugging scratchpad)]]
24+
25+
## Docker
26+
* [[Hyku on Docker]]
27+
* [[Running on docker]]
28+
29+
## Custom Themes
30+
* [[Creating Custom Themes]]
31+
32+
## Bulkrax: Import & Export
33+
* [[Field Mappings]]
34+
35+
## Flexible Metadata
36+
* [Documentation](https://samvera.atlassian.net/wiki/spaces/hyku/pages/3185541198/Flexible+Metadata+v6.2)
37+
38+
## Management
39+
* [[Create super admin user]]
40+
* [[Super Admin vs Admin]]
41+
* [[Set email addresses]]
42+
* [[Give tenant user admin role]]
43+
* [[Issues with images not rendering]]
44+
* [[Import from purl]] (Stanford-specific)
45+
* [[Selecting Custom Themes]]
46+
* [[Groups with Roles Feature]]
47+
* [[Valkyrie Migration]]

0 commit comments

Comments
 (0)