404
+ +Page not found
+ + +'+ escapeHtml(title) + '
' + escapeHtml(summary) +'
+
+
+
+ Page not found
+ + +This is a simple example of a markdown file. You can use markdown to format your text.
+ +Here's a place for extended gratitude.
+ +This page is a synopsis and overview of how to create a DHRIFT workshop. Alternately, you could complete our workshop on Creating a DHRIFT Workshop.
DHRIFT is predicated on the idea that learning is a means of building communities of practice and that learning communities are best positioned to determine what to focus on and how to organize their own learning events. As a result, we have created a workflow for taking the content available through DHRIFT Core's directory of workshops and to create a landing page that draws from that content and allows for customization.
+A DHRIFT Institute Landing Page is a static webpage that can be hosted for free on GitHub pages. When creating your own series of workshops, digital institute, or even a course, you may want to pick and choose which workshops you would like to include. A DHRIFT Institute Landing Page assembles important information about your event combines it with a list of DHRIFT workshops of your choosing, and generates a static web page for participants to use. See our GC Digital Research Institute) for an example.
+DHRIFT's Institute Landing Page requires that you have a GitHub account set up in order to generate the site and to post it on GitHub pages.
+To make the site creation process easier, the DHRIFT Wizard will walk users through the step-by-step process of creating a new DHRIFT Institute Landing Page. The wizard will ask for core information about your institute. Then you will click on a "Create Site" button. The Wizard will take the information you have input, combine it with the workshops and features of the DHRIFT App, and then store a new repository in your GitHub account. When your Landing Page is complete, navigate to http://dhrift.
Begin using the DHRIFT Wizard at https://app.dhrift.org/wizard.
+The DHRIFT Wizard is an application that collects information that you in put into each field. When you click "Create Institute," the application assembles all of the information and stores it in a file. DHRIFT takes
+From the dhrift.org landing page, click the "Grow" link, or use this URL: https://dhrift.org/create.
+Go to https://dhrift.org/create to access the DHRIFT Institute Landing Page Wizard.
+<
The first page of the wizard will encourage you to assemble all of the information you need before getting started. That information may include the following:
+Currently, DHRIFT cannot store information about your institute in the browser and it is unable to read from files already in your repository. As a result, creating an institute automatically overwrites the previous institute information. Admittedly, this is not ideal and is a known bug. Our recommendation in the meantime is to create a folder or file that contains all of the information you are about to input into the Wizard. Use that file to copy and paste the data into the wizard. Doing so will mean that your changes are not lost and that you can continue to make changes. We apologize for the inconvenience, but we are working to make this part of the process go more smoothly as part of ongoing development.
+The DHRIFT Wizard will ask first for information pertaining to the entire event or institute you are creating. This includes the following fields which are explained in detail:
+The title in the General Information section of the DHRIFT Wizard refers to the title that will appear in the institute landing page hero slide at the top of the page. Since DHRIFT can be used for a variety of learning settings, this might be the name of the event (such as the GC Digital Research Institute) or the title of the course you are teaching.
+** This field is required **
+** This field is required **
+Using the date picker, select the starting date and end date of your event. You do not need to choose times at this point. More specific information about sessions include information for times and dates. This information will display inside the image at the top of the DHRIFT Landing Page.
+You can include information about what type of learning event this will be. There are three options: Online, In-person, and Hybrid. Select the radio button next to the most appropriate description. This field is optional.
+** This field is required. **
+Insert the name of the organization or group hosting the learning event. For example: Our University, Research Office.
+Insert text up to a maximum of 10 words for a tagline. This text will appear in the right hand side of the hero image at the top of the page. This field is optional. If there is no text inside the area will simply not display text.
+Text entered into this field will display on the DHRIFT Institute Landing Page directly below the hero image and above the schedule. Only text up to 150 words will display properly. This field is not required and if it is left blank no text will display on this area of the page.
+This documentation is designed to help you learn how to use the DHRIFT platform to create and manage digital humanities workshops and events.
+To learn more about the DHRIFT project, please visit the DHRIFT informational website.
+To start learning or teaching with the platform, visit the DHRIFT app.
+ +How Does DHRIFT Work?
+DHRIFT is built on a few key technologies that make it easy to create, manage, and publish DH workshops. These technologies include:
+GitHub: DHRIFT uses GitHub to store and manage workshop content. Each workshop is stored in a GitHub repository, which contains the workshop’s markdown files, images, and other assets. GitHub also provides version control, so you can track changes to your workshop content over time.
+Markdown: DHRIFT uses Markdown to write workshop content. Markdown is a lightweight markup language that is easy to read and write. It allows you to format text, add images, and create links without having to write HTML.
+YAML: DHRIFT uses YAML to configure workshop metadata. YAML is a human-readable data serialization format that is easy to read and write. It allows you to specify metadata such as the workshop title, author, and description.
+React: DHRIFT’s frontend is built with React, a JavaScript library for building user interfaces. React allows us to create interactive, responsive, and accessible interfaces for our workshops.
+WebAssembly: DHRIFT uses WebAssembly to run code snippets in the browser. WebAssembly is a low-level programming language that is designed to run fast and efficiently in web browsers. It allows us to incorporate code editors in a secure and sandboxed environment so that learners can immediately see the results of their code.
+GitHub Actions: DHRIFT uses GitHub Actions to automate the process of building and deploying workshop content. When you make changes to your workshop content, GitHub Actions will automatically build and deploy the changes to your DHRIFT site.
+Welcome to the documentation for DHRIFT (Digital Humanities Resource Infrastructure for Teaching Technology). This documentation is designed to help you get started with DHRIFT, understand its features, and learn how to customize and contribute to the platform.
+To get started, select a topic from the sidebar to the left. If you have any questions or need assistance, please contact the DHRIFT Team.
+ +This is a place holder for information about how to learn with DHRIFT. For example, it will cover various features that you can use, what's there, how to get the most out of the platform, etc.
+ +We should have information about the licensing.
+ +If you have an idea for a new workshop that you would like to propose to add to our core curriculum, please follow the steps below:
+Any special requirements or resources needed to develop the workshop
+Before proposing a new workshop, please review our workshop development guidelines to ensure that your workshop follows best pedagogical practices and includes all necessary information.
+If your workshop proposal is accepted, we'll contact you to discuss next steps. You'll be responsible for developing the workshop content and materials, which will be reviewed by the DHRIFT Curriculum team before being added to the core curriculum. Once your workshop is created, follow the steps below to submit it for review.
+If you've already developed a workshop and proposed the workshop to our team, you can submit it for review by following the steps below:
+Create a free GitHub account if you don't already have one. You'll need a GitHub account to submit your workshop materials and collaborate with the DHRIFT Curriculum Team. You can sign up for an account at GitHub.com.
+Make sure your workshop aligns with our workshop development guidelines. +Contact the DHRIFT Curriculum Team who will then give you upload access to our submission repository.
+Clone the submission repository to your local machine and add your workshop materials to the repository. (You can also manually upload your workshop materials to the repository through the GitHub interface.) When adding your workshop materials, make sure to include the following files and information:
+/images directory and add your images to that folder. Your folder should be named the same as your workshop markdown file. Make sure to reference the images in your markdown file using the correct file path, e.g, If your workshop is supported by additional resources (e.g., code files, datasets), you must create a new folder in the /uploads directory and add your materials to that folder. Your folder should be named the same as your workshop markdown file. Make sure to reference the resources in your markdown file using the correct file path, e.g., /uploads/your-folder/your-resource.csv
Create a pull request to submit your workshop for review. In your pull request, include a brief description of your workshop's materials and any special instructions or requirements for review.
+Once your pull request is submitted, the DHRIFT Curriculum Team will review your workshop and provide feedback by creating an issue. Issues act as a way to track and discuss changes to your workshop. We will correct any immediate formatting errors but you may be asked to make revisions to your workshop based on this feedback. All subsequent revisions should be made directly to the files in our submissions repository to ensure you are working from the latest version of the lesson file. Please respond to any feedback in a timely manner to expedite the review process. Note that issues, and subsequently the peer review discussion, are public. If you wish to speak with us privately about any feedback, please email the DHRIFT Curriculum Team.
+After your workshop has been reviewed and accepted, we will merge your pull request and your workshop will be added to the core curriculum. You will be credited as the workshop creator and will have the opportunity to contribute to future updates and revisions.
+If you would like to revise or update your workshop after it has been published, you can create a new pull request with your changes. The DHRIFT Curriculum Team will review your revisions and update the workshop as needed, following the same process as above.
+Please note that if we encounter errors in your workshop that are the result of further development of the DHRIFT platform, we will make the necessary changes to your workshop to ensure that it remains functional and accessible. We will notify you of any changes made to your workshop and provide an opportunity for you to review and approve them before they are published.
+After 3 years, we will add a note to the workshop indicating that it might be out of date and may need to be updated. We will also reach out to you to see if you would like to update the workshop or if you would like us to archive it.
+If you have any questions or need assistance with proposing or submitting a workshop, please contact the DHRIFT Curriculum Team. We're here to help!
+All workshops submitted to the DHRIFT Curriculum Team for review will undergo a peer review process to ensure that they meet our workshop development guidelines and pedagogical standards. The peer review process includes the following steps:
+Initial Review: The DHRIFT Curriculum Team will review your workshop proposal or submission to ensure that it aligns with our guidelines and includes all necessary information.
+Peer Review: Your workshop will be reviewed by members of the DHRIFT Curriculum Team and external reviewers with expertise in the workshop topic. Reviewers will provide feedback on the content, structure, and pedagogical approach of your workshop in a GitHub issue.
+Feedback and Revisions: Check the feedback on your workshop from the DHRIFT Curriculum Team and reviewers. You may be asked to make revisions to your workshop based on this feedback.
+Final Review: Once your workshop has been revised, it will undergo a final review by the DHRIFT Curriculum Team to ensure that all feedback has been addressed and that the workshop meets our standards.
+Acceptance and Publication: If your workshop is accepted, it will be added to the core curriculum and made available to the public. You will be credited as the workshop creator and will have the opportunity to contribute to future updates and revisions.
+The peer review process is designed to ensure that all workshops in the DHRIFT core curriculum meet our high standards for quality, accessibility, and engagement. We appreciate your contributions to our community of practice and look forward to working with you to develop innovative and engaging workshops for digital humanities research and teaching.
+Once your workshop has been accepted and published in the core curriculum, it will be available to the public through the DHRIFT platform. Participants will be able to access your workshop materials, resources, and activities, and engage with the content at their own pace.
+As the workshop creator, you will have the opportunity to update and revise your workshop as needed, based on feedback from participants and the DHRIFT Curriculum Team. You can also contribute new workshops and resources to the core curriculum, expanding the range of topics and activities available to our community of learners.
+The DHRIFT Curriculum Team is committed to providing a transparent and inclusive peer review process for all workshop submissions. We welcome feedback and suggestions for improving our review process and ensuring that all workshops meet our high standards for quality and accessibility.
+ +' + escapeHtml(summary) +'
' + noResultsText + '
'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..4b59830 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Welcome # Welcome to the documentation for DHRIFT (Digital Humanities Resource Infrastructure for Teaching Technology). This documentation is designed to help you get started with DHRIFT, understand its features, and learn how to customize and contribute to the platform. To get started, select a topic from the sidebar to the left. If you have any questions or need assistance, please contact the DHRIFT Team .","title":"Welcome"},{"location":"#welcome","text":"Welcome to the documentation for DHRIFT (Digital Humanities Resource Infrastructure for Teaching Technology). This documentation is designed to help you get started with DHRIFT, understand its features, and learn how to customize and contribute to the platform. To get started, select a topic from the sidebar to the left. If you have any questions or need assistance, please contact the DHRIFT Team .","title":"Welcome"},{"location":"about/","text":"About # This is a simple example of a markdown file. You can use markdown to format your text.","title":"About"},{"location":"about/#about","text":"This is a simple example of a markdown file. You can use markdown to format your text.","title":"About"},{"location":"acknowledgements/","text":"Acknowledgements # Here's a place for extended gratitude.","title":"Acknowledgements"},{"location":"acknowledgements/#acknowledgements","text":"Here's a place for extended gratitude.","title":"Acknowledgements"},{"location":"createworkshop/","text":"Create a DHRIFT Workshop # This page is a synopsis and overview of how to create a DHRIFT workshop. Alternately, you could complete our workshop on Creating a DHRIFT Workshop.","title":"Creating a DHRIFT workshop"},{"location":"createworkshop/#create-a-dhrift-workshop","text":"This page is a synopsis and overview of how to create a DHRIFT workshop. Alternately, you could complete our workshop on Creating a DHRIFT Workshop.","title":"Create a DHRIFT Workshop"},{"location":"customize/","text":"Create a DHRIFT Institute Landing Page # DHRIFT is predicated on the idea that learning is a means of building communities of practice and that learning communities are best positioned to determine what to focus on and how to organize their own learning events. As a result, we have created a workflow for taking the content available through DHRIFT Core's directory of workshops and to create a landing page that draws from that content and allows for customization. What is a DHRIFT Institute Landing Page # A DHRIFT Institute Landing Page is a static webpage that can be hosted for free on GitHub pages. When creating your own series of workshops, digital institute, or even a course, you may want to pick and choose which workshops you would like to include. A DHRIFT Institute Landing Page assembles important information about your event combines it with a list of DHRIFT workshops of your choosing, and generates a static web page for participants to use. See our GC Digital Research Institute ) for an example. Requirements to Create a DHRIFT Landing Page # DHRIFT's Institute Landing Page requires that you have a GitHub account set up in order to generate the site and to post it on GitHub pages. About the DHRIFT Wizard # Overview # To make the site creation process easier, the DHRIFT Wizard will walk users through the step-by-step process of creating a new DHRIFT Institute Landing Page. The wizard will ask for core information about your institute. Then you will click on a \"Create Site\" button. The Wizard will take the information you have input, combine it with the workshops and features of the DHRIFT App, and then store a new repository in your GitHub account. When your Landing Page is complete, navigate to http://dhrift. .github.io and see what you've created. Begin using the DHRIFT Wizard at https://app.dhrift.org/wizard . How the DHRIFT Wizard Works # The DHRIFT Wizard is an application that collects information that you in put into each field. When you click \"Create Institute,\" the application assembles all of the information and stores it in a file. DHRIFT takes Accessing the DHRIFT Wizard # From the dhrift.org landing page, click the \"Grow\" link, or use this URL: https://dhrift.org/create . Getting Started # Go to https://dhrift.org/create to access the DHRIFT Institute Landing Page Wizard. < > The first page of the wizard will encourage you to assemble all of the information you need before getting started. That information may include the following: A title, description, format, location, and contact information for your event Dates, times, titles, DHRIFT workshops, resources, names and contact names of instructors, and any details participants should know. Any social media, sponsors, logos, and/or a replacement hero image you may want to use in place of our defaults Your GitHub credentials. TIP # Currently, DHRIFT cannot store information about your institute in the browser and it is unable to read from files already in your repository. As a result, creating an institute automatically overwrites the previous institute information. Admittedly, this is not ideal and is a known bug. Our recommendation in the meantime is to create a folder or file that contains all of the information you are about to input into the Wizard. Use that file to copy and paste the data into the wizard. Doing so will mean that your changes are not lost and that you can continue to make changes. We apologize for the inconvenience, but we are working to make this part of the process go more smoothly as part of ongoing development. General Information # The DHRIFT Wizard will ask first for information pertaining to the entire event or institute you are creating. This includes the following fields which are explained in detail: The title # The title in the General Information section of the DHRIFT Wizard refers to the title that will appear in the institute landing page hero slide at the top of the page. Since DHRIFT can be used for a variety of learning settings, this might be the name of the event (such as the GC Digital Research Institute) or the title of the course you are teaching. ** This field is required ** Institute / Event / Course Dates # ** This field is required ** Using the date picker, select the starting date and end date of your event. You do not need to choose times at this point. More specific information about sessions include information for times and dates. This information will display inside the image at the top of the DHRIFT Landing Page. Format # You can include information about what type of learning event this will be. There are three options: Online, In-person, and Hybrid. Select the radio button next to the most appropriate description. This field is optional. Host or Organizer # ** This field is required. ** Insert the name of the organization or group hosting the learning event. For example: Our University, Research Office. Tagline # Insert text up to a maximum of 10 words for a tagline. This text will appear in the right hand side of the hero image at the top of the page. This field is optional. If there is no text inside the area will simply not display text. Short Description # Text entered into this field will display on the DHRIFT Institute Landing Page directly below the hero image and above the schedule. Only text up to 150 words will display properly. This field is not required and if it is left blank no text will display on this area of the page. Things to consider # Editing your DHRIFT Institute site # Troubleshooting #","title":"Customizing a DHRIFT Institute"},{"location":"customize/#create-a-dhrift-institute-landing-page","text":"DHRIFT is predicated on the idea that learning is a means of building communities of practice and that learning communities are best positioned to determine what to focus on and how to organize their own learning events. As a result, we have created a workflow for taking the content available through DHRIFT Core's directory of workshops and to create a landing page that draws from that content and allows for customization.","title":"Create a DHRIFT Institute Landing Page"},{"location":"customize/#what-is-a-dhrift-institute-landing-page","text":"A DHRIFT Institute Landing Page is a static webpage that can be hosted for free on GitHub pages. When creating your own series of workshops, digital institute, or even a course, you may want to pick and choose which workshops you would like to include. A DHRIFT Institute Landing Page assembles important information about your event combines it with a list of DHRIFT workshops of your choosing, and generates a static web page for participants to use. See our GC Digital Research Institute ) for an example.","title":"What is a DHRIFT Institute Landing Page"},{"location":"customize/#requirements-to-create-a-dhrift-landing-page","text":"DHRIFT's Institute Landing Page requires that you have a GitHub account set up in order to generate the site and to post it on GitHub pages.","title":"Requirements to Create a DHRIFT Landing Page"},{"location":"customize/#about-the-dhrift-wizard","text":"","title":"About the DHRIFT Wizard"},{"location":"customize/#overview","text":"To make the site creation process easier, the DHRIFT Wizard will walk users through the step-by-step process of creating a new DHRIFT Institute Landing Page. The wizard will ask for core information about your institute. Then you will click on a \"Create Site\" button. The Wizard will take the information you have input, combine it with the workshops and features of the DHRIFT App, and then store a new repository in your GitHub account. When your Landing Page is complete, navigate to http://dhrift. .github.io and see what you've created. Begin using the DHRIFT Wizard at https://app.dhrift.org/wizard .","title":"Overview"},{"location":"customize/#how-the-dhrift-wizard-works","text":"The DHRIFT Wizard is an application that collects information that you in put into each field. When you click \"Create Institute,\" the application assembles all of the information and stores it in a file. DHRIFT takes","title":"How the DHRIFT Wizard Works"},{"location":"customize/#accessing-the-dhrift-wizard","text":"From the dhrift.org landing page, click the \"Grow\" link, or use this URL: https://dhrift.org/create .","title":"Accessing the DHRIFT Wizard"},{"location":"customize/#getting-started","text":"Go to https://dhrift.org/create to access the DHRIFT Institute Landing Page Wizard. < > The first page of the wizard will encourage you to assemble all of the information you need before getting started. That information may include the following: A title, description, format, location, and contact information for your event Dates, times, titles, DHRIFT workshops, resources, names and contact names of instructors, and any details participants should know. Any social media, sponsors, logos, and/or a replacement hero image you may want to use in place of our defaults Your GitHub credentials.","title":"Getting Started"},{"location":"customize/#tip","text":"Currently, DHRIFT cannot store information about your institute in the browser and it is unable to read from files already in your repository. As a result, creating an institute automatically overwrites the previous institute information. Admittedly, this is not ideal and is a known bug. Our recommendation in the meantime is to create a folder or file that contains all of the information you are about to input into the Wizard. Use that file to copy and paste the data into the wizard. Doing so will mean that your changes are not lost and that you can continue to make changes. We apologize for the inconvenience, but we are working to make this part of the process go more smoothly as part of ongoing development.","title":"TIP"},{"location":"customize/#general-information","text":"The DHRIFT Wizard will ask first for information pertaining to the entire event or institute you are creating. This includes the following fields which are explained in detail:","title":"General Information"},{"location":"customize/#the-title","text":"The title in the General Information section of the DHRIFT Wizard refers to the title that will appear in the institute landing page hero slide at the top of the page. Since DHRIFT can be used for a variety of learning settings, this might be the name of the event (such as the GC Digital Research Institute) or the title of the course you are teaching. ** This field is required **","title":"The title"},{"location":"customize/#institute-event-course-dates","text":"** This field is required ** Using the date picker, select the starting date and end date of your event. You do not need to choose times at this point. More specific information about sessions include information for times and dates. This information will display inside the image at the top of the DHRIFT Landing Page.","title":"Institute / Event / Course Dates"},{"location":"customize/#format","text":"You can include information about what type of learning event this will be. There are three options: Online, In-person, and Hybrid. Select the radio button next to the most appropriate description. This field is optional.","title":"Format"},{"location":"customize/#host-or-organizer","text":"** This field is required. ** Insert the name of the organization or group hosting the learning event. For example: Our University, Research Office.","title":"Host or Organizer"},{"location":"customize/#tagline","text":"Insert text up to a maximum of 10 words for a tagline. This text will appear in the right hand side of the hero image at the top of the page. This field is optional. If there is no text inside the area will simply not display text.","title":"Tagline"},{"location":"customize/#short-description","text":"Text entered into this field will display on the DHRIFT Institute Landing Page directly below the hero image and above the schedule. Only text up to 150 words will display properly. This field is not required and if it is left blank no text will display on this area of the page.","title":"Short Description"},{"location":"customize/#things-to-consider","text":"","title":"Things to consider"},{"location":"customize/#editing-your-dhrift-institute-site","text":"","title":"Editing your DHRIFT Institute site"},{"location":"customize/#troubleshooting","text":"","title":"Troubleshooting"},{"location":"features/","text":"Features # This is place holder text for a page about the features in DHRIFT broken down into sections For Learners # For Instructors # For Workshop Authors # For Institute Hosts #","title":"Features"},{"location":"features/#features","text":"This is place holder text for a page about the features in DHRIFT broken down into sections","title":"Features"},{"location":"features/#for-learners","text":"","title":"For Learners"},{"location":"features/#for-instructors","text":"","title":"For Instructors"},{"location":"features/#for-workshop-authors","text":"","title":"For Workshop Authors"},{"location":"features/#for-institute-hosts","text":"","title":"For Institute Hosts"},{"location":"glossary/","text":"The DHRIFT Glossary # This page is going to explain about the DHRIFT Glossary and the following sub topics: How to use the glossary # How to submit an entry for consideration # How to modify the glossary on your own DHRIFT institute site #","title":"Working with the Glossary"},{"location":"glossary/#the-dhrift-glossary","text":"This page is going to explain about the DHRIFT Glossary and the following sub topics:","title":"The DHRIFT Glossary"},{"location":"glossary/#how-to-use-the-glossary","text":"","title":"How to use the glossary"},{"location":"glossary/#how-to-submit-an-entry-for-consideration","text":"","title":"How to submit an entry for consideration"},{"location":"glossary/#how-to-modify-the-glossary-on-your-own-dhrift-institute-site","text":"","title":"How to modify the glossary on your own DHRIFT institute site"},{"location":"home/","text":"DHRIFT Documentation # This documentation is designed to help you learn how to use the DHRIFT platform to create and manage digital humanities workshops and events. To learn more about the DHRIFT project, please visit the DHRIFT informational website . To start learning or teaching with the platform, visit the DHRIFT app .","title":"DHRIFT Documentation"},{"location":"home/#dhrift-documentation","text":"This documentation is designed to help you learn how to use the DHRIFT platform to create and manage digital humanities workshops and events. To learn more about the DHRIFT project, please visit the DHRIFT informational website . To start learning or teaching with the platform, visit the DHRIFT app .","title":"DHRIFT Documentation"},{"location":"howdhrift/","text":"How Does DHRIFT Work? DHRIFT is built on a few key technologies that make it easy to create, manage, and publish DH workshops. These technologies include: GitHub: DHRIFT uses GitHub to store and manage workshop content. Each workshop is stored in a GitHub repository, which contains the workshop\u2019s markdown files, images, and other assets. GitHub also provides version control, so you can track changes to your workshop content over time. Markdown: DHRIFT uses Markdown to write workshop content. Markdown is a lightweight markup language that is easy to read and write. It allows you to format text, add images, and create links without having to write HTML. YAML: DHRIFT uses YAML to configure workshop metadata. YAML is a human-readable data serialization format that is easy to read and write. It allows you to specify metadata such as the workshop title, author, and description. React: DHRIFT\u2019s frontend is built with React , a JavaScript library for building user interfaces. React allows us to create interactive, responsive, and accessible interfaces for our workshops. WebAssembly: DHRIFT uses WebAssembly to run code snippets in the browser. WebAssembly is a low-level programming language that is designed to run fast and efficiently in web browsers. It allows us to incorporate code editors in a secure and sandboxed environment so that learners can immediately see the results of their code. GitHub Actions: DHRIFT uses GitHub Actions to automate the process of building and deploying workshop content. When you make changes to your workshop content, GitHub Actions will automatically build and deploy the changes to your DHRIFT site.","title":"How does DHRIFT work?"},{"location":"learn/","text":"How to Learn with DHRIFT # This is a place holder for information about how to learn with DHRIFT. For example, it will cover various features that you can use, what's there, how to get the most out of the platform, etc.","title":"Learning with DHRIFT"},{"location":"learn/#how-to-learn-with-dhrift","text":"This is a place holder for information about how to learn with DHRIFT. For example, it will cover various features that you can use, what's there, how to get the most out of the platform, etc.","title":"How to Learn with DHRIFT"},{"location":"license/","text":"License # We should have information about the licensing.","title":"License"},{"location":"license/#license","text":"We should have information about the licensing.","title":"License"},{"location":"modifyworkshop/","text":"Modifying a DHRIFT Workshop # Prerequisite: Getting Started #","title":"Modifying a DHRIFT workshop"},{"location":"modifyworkshop/#modifying-a-dhrift-workshop","text":"Prerequisite:","title":"Modifying a DHRIFT Workshop"},{"location":"modifyworkshop/#getting-started","text":"","title":"Getting Started"},{"location":"propose-submit/","text":"Propose and Submit a New Workshop # Proposing a New Workshop # If you have an idea for a new workshop that you would like to propose to add to our core curriculum , please follow the steps below: Contact the DHRIFT Curriculum Team to discuss your idea. We can help you refine your proposal and provide guidance on how to structure your workshop. In your email, please include the following information: An abstract for your workshop (100 words or less, will be used for the workshop description) The intended audience for your workshop The learning objectives and outcomes you hope to achieve Any special requirements or resources needed to develop the workshop Before proposing a new workshop, please review our workshop development guidelines to ensure that your workshop follows best pedagogical practices and includes all necessary information. If your workshop proposal is accepted, we'll contact you to discuss next steps. You'll be responsible for developing the workshop content and materials, which will be reviewed by the DHRIFT Curriculum team before being added to the core curriculum. Once your workshop is created, follow the steps below to submit it for review. Submitting a Workshop for Review # If you've already developed a workshop and proposed the workshop to our team, you can submit it for review by following the steps below: Create a free GitHub account if you don't already have one. You'll need a GitHub account to submit your workshop materials and collaborate with the DHRIFT Curriculum Team. You can sign up for an account at GitHub.com . Make sure your workshop aligns with our workshop development guidelines . Contact the DHRIFT Curriculum Team who will then give you upload access to our submission repository . Clone the submission repository to your local machine and add your workshop materials to the repository. (You can also manually upload your workshop materials to the repository through the GitHub interface.) When adding your workshop materials, make sure to include the following files and information: Your workshop markdown file in the root directory (see our workshop anatomy for formatting specifications and our workshop guidelines for content requirements) If your workshop contains images, you must create a new folder in the /images directory and add your images to that folder. Your folder should be named the same as your workshop markdown file. Make sure to reference the images in your markdown file using the correct file path, e.g,  If your workshop is supported by additional resources (e.g., code files, datasets), you must create a new folder in the /uploads directory and add your materials to that folder. Your folder should be named the same as your workshop markdown file. Make sure to reference the resources in your markdown file using the correct file path, e.g., /uploads/your-folder/your-resource.csv Create a pull request to submit your workshop for review. In your pull request, include a brief description of your workshop's materials and any special instructions or requirements for review. Once your pull request is submitted, the DHRIFT Curriculum Team will review your workshop and provide feedback by creating an issue . Issues act as a way to track and discuss changes to your workshop. We will correct any immediate formatting errors but you may be asked to make revisions to your workshop based on this feedback. All subsequent revisions should be made directly to the files in our submissions repository to ensure you are working from the latest version of the lesson file. Please respond to any feedback in a timely manner to expedite the review process. Note that issues, and subsequently the peer review discussion, are public. If you wish to speak with us privately about any feedback, please email the DHRIFT Curriculum Team . After your workshop has been reviewed and accepted, we will merge your pull request and your workshop will be added to the core curriculum. You will be credited as the workshop creator and will have the opportunity to contribute to future updates and revisions. If you would like to revise or update your workshop after it has been published, you can create a new pull request with your changes. The DHRIFT Curriculum Team will review your revisions and update the workshop as needed, following the same process as above. Please note that if we encounter errors in your workshop that are the result of further development of the DHRIFT platform, we will make the necessary changes to your workshop to ensure that it remains functional and accessible. We will notify you of any changes made to your workshop and provide an opportunity for you to review and approve them before they are published. After 3 years, we will add a note to the workshop indicating that it might be out of date and may need to be updated. We will also reach out to you to see if you would like to update the workshop or if you would like us to archive it. If you have any questions or need assistance with proposing or submitting a workshop, please contact the DHRIFT Curriculum Team . We're here to help! The Review Timeline # All workshops submitted to the DHRIFT Curriculum Team for review will undergo a peer review process to ensure that they meet our workshop development guidelines and pedagogical standards. The peer review process includes the following steps: Initial Review : The DHRIFT Curriculum Team will review your workshop proposal or submission to ensure that it aligns with our guidelines and includes all necessary information. Peer Review : Your workshop will be reviewed by members of the DHRIFT Curriculum Team and external reviewers with expertise in the workshop topic. Reviewers will provide feedback on the content, structure, and pedagogical approach of your workshop in a GitHub issue. Feedback and Revisions : Check the feedback on your workshop from the DHRIFT Curriculum Team and reviewers. You may be asked to make revisions to your workshop based on this feedback. Final Review : Once your workshop has been revised, it will undergo a final review by the DHRIFT Curriculum Team to ensure that all feedback has been addressed and that the workshop meets our standards. Acceptance and Publication : If your workshop is accepted, it will be added to the core curriculum and made available to the public. You will be credited as the workshop creator and will have the opportunity to contribute to future updates and revisions. The peer review process is designed to ensure that all workshops in the DHRIFT core curriculum meet our high standards for quality, accessibility, and engagement. We appreciate your contributions to our community of practice and look forward to working with you to develop innovative and engaging workshops for digital humanities research and teaching. After Your Workshop is Published # Once your workshop has been accepted and published in the core curriculum, it will be available to the public through the DHRIFT platform. Participants will be able to access your workshop materials, resources, and activities, and engage with the content at their own pace. As the workshop creator, you will have the opportunity to update and revise your workshop as needed, based on feedback from participants and the DHRIFT Curriculum Team. You can also contribute new workshops and resources to the core curriculum, expanding the range of topics and activities available to our community of learners. Holding Us Accountable # The DHRIFT Curriculum Team is committed to providing a transparent and inclusive peer review process for all workshop submissions. We welcome feedback and suggestions for improving our review process and ensuring that all workshops meet our high standards for quality and accessibility.","title":"Propose and Submit a Workshop"},{"location":"propose-submit/#propose-and-submit-a-new-workshop","text":"","title":"Propose and Submit a New Workshop"},{"location":"propose-submit/#proposing-a-new-workshop","text":"If you have an idea for a new workshop that you would like to propose to add to our core curriculum , please follow the steps below: Contact the DHRIFT Curriculum Team to discuss your idea. We can help you refine your proposal and provide guidance on how to structure your workshop. In your email, please include the following information: An abstract for your workshop (100 words or less, will be used for the workshop description) The intended audience for your workshop The learning objectives and outcomes you hope to achieve Any special requirements or resources needed to develop the workshop Before proposing a new workshop, please review our workshop development guidelines to ensure that your workshop follows best pedagogical practices and includes all necessary information. If your workshop proposal is accepted, we'll contact you to discuss next steps. You'll be responsible for developing the workshop content and materials, which will be reviewed by the DHRIFT Curriculum team before being added to the core curriculum. Once your workshop is created, follow the steps below to submit it for review.","title":"Proposing a New Workshop"},{"location":"propose-submit/#submitting-a-workshop-for-review","text":"If you've already developed a workshop and proposed the workshop to our team, you can submit it for review by following the steps below: Create a free GitHub account if you don't already have one. You'll need a GitHub account to submit your workshop materials and collaborate with the DHRIFT Curriculum Team. You can sign up for an account at GitHub.com . Make sure your workshop aligns with our workshop development guidelines . Contact the DHRIFT Curriculum Team who will then give you upload access to our submission repository . Clone the submission repository to your local machine and add your workshop materials to the repository. (You can also manually upload your workshop materials to the repository through the GitHub interface.) When adding your workshop materials, make sure to include the following files and information: Your workshop markdown file in the root directory (see our workshop anatomy for formatting specifications and our workshop guidelines for content requirements) If your workshop contains images, you must create a new folder in the /images directory and add your images to that folder. Your folder should be named the same as your workshop markdown file. Make sure to reference the images in your markdown file using the correct file path, e.g,  If your workshop is supported by additional resources (e.g., code files, datasets), you must create a new folder in the /uploads directory and add your materials to that folder. Your folder should be named the same as your workshop markdown file. Make sure to reference the resources in your markdown file using the correct file path, e.g., /uploads/your-folder/your-resource.csv Create a pull request to submit your workshop for review. In your pull request, include a brief description of your workshop's materials and any special instructions or requirements for review. Once your pull request is submitted, the DHRIFT Curriculum Team will review your workshop and provide feedback by creating an issue . Issues act as a way to track and discuss changes to your workshop. We will correct any immediate formatting errors but you may be asked to make revisions to your workshop based on this feedback. All subsequent revisions should be made directly to the files in our submissions repository to ensure you are working from the latest version of the lesson file. Please respond to any feedback in a timely manner to expedite the review process. Note that issues, and subsequently the peer review discussion, are public. If you wish to speak with us privately about any feedback, please email the DHRIFT Curriculum Team . After your workshop has been reviewed and accepted, we will merge your pull request and your workshop will be added to the core curriculum. You will be credited as the workshop creator and will have the opportunity to contribute to future updates and revisions. If you would like to revise or update your workshop after it has been published, you can create a new pull request with your changes. The DHRIFT Curriculum Team will review your revisions and update the workshop as needed, following the same process as above. Please note that if we encounter errors in your workshop that are the result of further development of the DHRIFT platform, we will make the necessary changes to your workshop to ensure that it remains functional and accessible. We will notify you of any changes made to your workshop and provide an opportunity for you to review and approve them before they are published. After 3 years, we will add a note to the workshop indicating that it might be out of date and may need to be updated. We will also reach out to you to see if you would like to update the workshop or if you would like us to archive it. If you have any questions or need assistance with proposing or submitting a workshop, please contact the DHRIFT Curriculum Team . We're here to help!","title":"Submitting a Workshop for Review"},{"location":"propose-submit/#the-review-timeline","text":"All workshops submitted to the DHRIFT Curriculum Team for review will undergo a peer review process to ensure that they meet our workshop development guidelines and pedagogical standards. The peer review process includes the following steps: Initial Review : The DHRIFT Curriculum Team will review your workshop proposal or submission to ensure that it aligns with our guidelines and includes all necessary information. Peer Review : Your workshop will be reviewed by members of the DHRIFT Curriculum Team and external reviewers with expertise in the workshop topic. Reviewers will provide feedback on the content, structure, and pedagogical approach of your workshop in a GitHub issue. Feedback and Revisions : Check the feedback on your workshop from the DHRIFT Curriculum Team and reviewers. You may be asked to make revisions to your workshop based on this feedback. Final Review : Once your workshop has been revised, it will undergo a final review by the DHRIFT Curriculum Team to ensure that all feedback has been addressed and that the workshop meets our standards. Acceptance and Publication : If your workshop is accepted, it will be added to the core curriculum and made available to the public. You will be credited as the workshop creator and will have the opportunity to contribute to future updates and revisions. The peer review process is designed to ensure that all workshops in the DHRIFT core curriculum meet our high standards for quality, accessibility, and engagement. We appreciate your contributions to our community of practice and look forward to working with you to develop innovative and engaging workshops for digital humanities research and teaching.","title":"The Review Timeline"},{"location":"propose-submit/#after-your-workshop-is-published","text":"Once your workshop has been accepted and published in the core curriculum, it will be available to the public through the DHRIFT platform. Participants will be able to access your workshop materials, resources, and activities, and engage with the content at their own pace. As the workshop creator, you will have the opportunity to update and revise your workshop as needed, based on feedback from participants and the DHRIFT Curriculum Team. You can also contribute new workshops and resources to the core curriculum, expanding the range of topics and activities available to our community of learners.","title":"After Your Workshop is Published"},{"location":"propose-submit/#holding-us-accountable","text":"The DHRIFT Curriculum Team is committed to providing a transparent and inclusive peer review process for all workshop submissions. We welcome feedback and suggestions for improving our review process and ensuring that all workshops meet our high standards for quality and accessibility.","title":"Holding Us Accountable"},{"location":"teaching/","text":"Teaching with DHRIFT # This text will cover approaches to teaching with the workshops and the DHRIFt features.","title":"Teaching Tips"},{"location":"teaching/#teaching-with-dhrift","text":"This text will cover approaches to teaching with the workshops and the DHRIFt features.","title":"Teaching with DHRIFT"},{"location":"whatis/","text":"What is DHRIFT? # DHRIFT (Digital Humanities Resource Infrastructure for Teaching Technology) is an open educational resource (OER) and publication platform for digital humanities (DH) workshops. Designed by humanities scholars for humanities scholars, DHRIFT provides a minimal computing, accessibility-aware, and interactive environment for teaching fundamental DH concepts. The platform includes a core set of more than 10 reviewed and tested workshops that have been developed and tested during two NEH-funded, week-long institutes, called the Digital Humanities Research Institutes (DHRI). Workshop topics range from learning the basics of Python, JavaScript, and R to conducting research through text analysis, data wrangling, and mapping. You can see the full list of workshops on the workshops page, accessible from the header menu or by clicking here. DHRIFT\u2019s core workshops are always accessible from and usable on our website; however, its flexible framework also allows users to build their own customized, static DHRIFT sites and tailor them for a variety of situations, such as teaching an undergraduate or graduate class, hosting a week-long skills institute, or organizing a series of professional development workshops. DHRIFT facilitates an instructor or organizations\u2019 ability to reproduce, adapt, and publish DH workshops with interactive, learner-focused features. All workshop content is accessible in the browser, avoiding the need for learners to install software or set up complex computing environments. While we realize everyone learns differently and no one tool can solve for the wide variety of possible hurdles for teaching and learning digital skills, DHRIFT is designed to be flexible. We have found that it can be useful in remote, in-person, and self-instructional modalities. It is designed to be accessible to learners of all backgrounds and skill levels, from beginners to more advanced users, but our content tends toward beginners. Whether you're new to digital humanities or an experienced practitioner, DHRIFT has something to offer you.","title":"What is DHRIFT?"},{"location":"whatis/#what-is-dhrift","text":"DHRIFT (Digital Humanities Resource Infrastructure for Teaching Technology) is an open educational resource (OER) and publication platform for digital humanities (DH) workshops. Designed by humanities scholars for humanities scholars, DHRIFT provides a minimal computing, accessibility-aware, and interactive environment for teaching fundamental DH concepts. The platform includes a core set of more than 10 reviewed and tested workshops that have been developed and tested during two NEH-funded, week-long institutes, called the Digital Humanities Research Institutes (DHRI). Workshop topics range from learning the basics of Python, JavaScript, and R to conducting research through text analysis, data wrangling, and mapping. You can see the full list of workshops on the workshops page, accessible from the header menu or by clicking here. DHRIFT\u2019s core workshops are always accessible from and usable on our website; however, its flexible framework also allows users to build their own customized, static DHRIFT sites and tailor them for a variety of situations, such as teaching an undergraduate or graduate class, hosting a week-long skills institute, or organizing a series of professional development workshops. DHRIFT facilitates an instructor or organizations\u2019 ability to reproduce, adapt, and publish DH workshops with interactive, learner-focused features. All workshop content is accessible in the browser, avoiding the need for learners to install software or set up complex computing environments. While we realize everyone learns differently and no one tool can solve for the wide variety of possible hurdles for teaching and learning digital skills, DHRIFT is designed to be flexible. We have found that it can be useful in remote, in-person, and self-instructional modalities. It is designed to be accessible to learners of all backgrounds and skill levels, from beginners to more advanced users, but our content tends toward beginners. Whether you're new to digital humanities or an experienced practitioner, DHRIFT has something to offer you.","title":"What is DHRIFT?"},{"location":"workshop-guidelines/","text":"Workshop Guidelines # These guidelines have been prepared to help you develop effective and engaging workshops for the DHRIFT platform. By following these guidelines, you can ensure that your workshop aligns with best pedagogical practices. While you are free to develop workshops on any topic related to digital humanities research and teaching, if you would like to propose a workshop for inclusion in the DHRIFT core curriculum, please review these guidelines first to ensure that your workshop meets our standards for quality, accessibility, and engagement. Getting Started # As you flesh out your workshop idea, consider the following questions to create an effective and engaging learning experience: What skill level is your workshop aimed at? (beginner, intermediate, advanced)? How does the workshop align with other workshops (if applicable) in the curriculum? Is there a clear progression of skills and knowledge across workshops? What are the learning objectives and outcomes you hope to achieve with your workshop? How will participants benefit from attending your workshop? What teaching methods and activities will you use to engage participants and facilitate learning? How will you assess participant learning and understanding? What resources and materials will you need to develop your workshop? Are there any special requirements or considerations to keep in mind? Style and Approach # DHRIFT workshops are not typically lecture-based but are designed to be interactive and hands-on. Reviewing the interactive features available in the DHRIFT platform can help prepare you for how you might structure your content and assess participant learning. In general, DHRIFT workshops work best when: - Your tone is formal but accessible, engaging, and inclusive. DHRIFT workshops should reflect the values of bias-free language and inclusive pedagogy. You can read more about writing with inclusive language in the APA Style Guide . - They are created with a variety of teaching modalities in mind. DHRIFT workshops should be accessible to a wide range of learners, from in-person to online. Consider how you might adapt your content for different learning environments. - Your content is clear, concise, and engaging. DHRIFT workshops should be easy to follow and understand, with clear instructions and explanations. Use examples, case studies, and activities to illustrate key concepts and engage participants. Keep in mind that technical jargon should be thoroughly explained and reinforced throughout the workshop. - Your lessons are well-organized and structured. DHRIFT workshops should follow a logical sequence of topics and activities, with clear transitions between sections. Use headings, subheadings, and bullet points to break up text and make it easier to read. Keep in mind this is a participatory workshop, not a lecture or an academic paper. Open-Source and Open-Access # DHRIFT workshops are open-source and open-access, meaning that they are freely available to the public and can be reused, remixed, and redistributed under a Creative Commons license .TODO: what kind? By contributing to the DHRIFT platform, you agree to share your work with the wider community of digital humanities researchers and educators. Write for a Diverse Audience # When developing your workshop, keep in mind that your content will be shared with a diverse audience of learners, from students and scholars to professionals and enthusiasts. Make sure that your content is accessible, inclusive, and engaging to a wide range of participants. Follow these global-facing guidelines to ensure that your workshop is welcoming and respectful to all learners: - Use inclusive language that is free from bias, stereotypes, and discrimination. - Cultural references should be given context or explained. Assume that your audience is not familiar with specific cultural references. - Avoid using regional humor or sarcasm that may be misinterpreted or offensive. - Use images, examples, and case studies that reflect the diversity of the global community. - When referencing geographic locations, be specific: use the full name of the location (e.g., United States instead of US) to avoid confusion. - Be mindful when using racial or ethnic language. Historic terms no longer in use should be used only in their historical context and only when necessary. - Avoid using gendered language when possible. Write for the Future # DHRIFT workshops should ideally be relevant and useful to participants for years to come. When developing your workshop, consider how you can future-proof your content by: - Note what version of software or tools you are using. If possible, use the most recent version and provide instructions for updating or adapting to future versions. - Reduce reliance on screenshots or images that may change over time (e.g., user interfaces, websites). - Pointing to external resources or documentation for tools or technologies that may change frequently. - Use open data sources or datasets that are freely available and accessible to all participants. Include them in your workshop materials or provide links to where they can be accessed. If you are submitting a workshop to our core curriculum, it is likely we will ask you to update your workshop (if needed) to ensure that it remains relevant and up-to-date. See our submission guidelines for more information. Specific Writing Guidelines # This section contains specific guidelines for writing content for DHRIFT workshops. Please review these guidelines before and after you write your workshop content. When using coding terms or syntax in written paragraphs, use backticks ( `foo` ) to indicate they are code. When using code blocks, use triple backticks ( ``` ) to enclose the code block. For example: python def hello_world(): print(\"Hello, World!\") Use headings and subheadings to organize your content. Level 1 headings ( # ) should be used for main sections, level 2 headings ( ## ) for subsections that you want to to be visible in the table of contents, and level 3 headings ( ### ) for subsections that you want to use for readability but be hidden in the table of contents. Use quotes to highlight key points, definitions, or examples. Quotes should be formatted as follows: markdown > This is a quote. Use lists (bulleted or numbered) to break up text and make it easier to read. Lists should be formatted as follows: ```markdown This is a bulleted list item. This is another bulleted list item. markdown This is a numbered list item. This is another numbered list item. ``` Content Formatting Guidelines #","title":"Workshop Guidelines"},{"location":"workshop-guidelines/#workshop-guidelines","text":"These guidelines have been prepared to help you develop effective and engaging workshops for the DHRIFT platform. By following these guidelines, you can ensure that your workshop aligns with best pedagogical practices. While you are free to develop workshops on any topic related to digital humanities research and teaching, if you would like to propose a workshop for inclusion in the DHRIFT core curriculum, please review these guidelines first to ensure that your workshop meets our standards for quality, accessibility, and engagement.","title":"Workshop Guidelines"},{"location":"workshop-guidelines/#getting-started","text":"As you flesh out your workshop idea, consider the following questions to create an effective and engaging learning experience: What skill level is your workshop aimed at? (beginner, intermediate, advanced)? How does the workshop align with other workshops (if applicable) in the curriculum? Is there a clear progression of skills and knowledge across workshops? What are the learning objectives and outcomes you hope to achieve with your workshop? How will participants benefit from attending your workshop? What teaching methods and activities will you use to engage participants and facilitate learning? How will you assess participant learning and understanding? What resources and materials will you need to develop your workshop? Are there any special requirements or considerations to keep in mind?","title":"Getting Started"},{"location":"workshop-guidelines/#style-and-approach","text":"DHRIFT workshops are not typically lecture-based but are designed to be interactive and hands-on. Reviewing the interactive features available in the DHRIFT platform can help prepare you for how you might structure your content and assess participant learning. In general, DHRIFT workshops work best when: - Your tone is formal but accessible, engaging, and inclusive. DHRIFT workshops should reflect the values of bias-free language and inclusive pedagogy. You can read more about writing with inclusive language in the APA Style Guide . - They are created with a variety of teaching modalities in mind. DHRIFT workshops should be accessible to a wide range of learners, from in-person to online. Consider how you might adapt your content for different learning environments. - Your content is clear, concise, and engaging. DHRIFT workshops should be easy to follow and understand, with clear instructions and explanations. Use examples, case studies, and activities to illustrate key concepts and engage participants. Keep in mind that technical jargon should be thoroughly explained and reinforced throughout the workshop. - Your lessons are well-organized and structured. DHRIFT workshops should follow a logical sequence of topics and activities, with clear transitions between sections. Use headings, subheadings, and bullet points to break up text and make it easier to read. Keep in mind this is a participatory workshop, not a lecture or an academic paper.","title":"Style and Approach"},{"location":"workshop-guidelines/#open-source-and-open-access","text":"DHRIFT workshops are open-source and open-access, meaning that they are freely available to the public and can be reused, remixed, and redistributed under a Creative Commons license .TODO: what kind? By contributing to the DHRIFT platform, you agree to share your work with the wider community of digital humanities researchers and educators.","title":"Open-Source and Open-Access"},{"location":"workshop-guidelines/#write-for-a-diverse-audience","text":"When developing your workshop, keep in mind that your content will be shared with a diverse audience of learners, from students and scholars to professionals and enthusiasts. Make sure that your content is accessible, inclusive, and engaging to a wide range of participants. Follow these global-facing guidelines to ensure that your workshop is welcoming and respectful to all learners: - Use inclusive language that is free from bias, stereotypes, and discrimination. - Cultural references should be given context or explained. Assume that your audience is not familiar with specific cultural references. - Avoid using regional humor or sarcasm that may be misinterpreted or offensive. - Use images, examples, and case studies that reflect the diversity of the global community. - When referencing geographic locations, be specific: use the full name of the location (e.g., United States instead of US) to avoid confusion. - Be mindful when using racial or ethnic language. Historic terms no longer in use should be used only in their historical context and only when necessary. - Avoid using gendered language when possible.","title":"Write for a Diverse Audience"},{"location":"workshop-guidelines/#write-for-the-future","text":"DHRIFT workshops should ideally be relevant and useful to participants for years to come. When developing your workshop, consider how you can future-proof your content by: - Note what version of software or tools you are using. If possible, use the most recent version and provide instructions for updating or adapting to future versions. - Reduce reliance on screenshots or images that may change over time (e.g., user interfaces, websites). - Pointing to external resources or documentation for tools or technologies that may change frequently. - Use open data sources or datasets that are freely available and accessible to all participants. Include them in your workshop materials or provide links to where they can be accessed. If you are submitting a workshop to our core curriculum, it is likely we will ask you to update your workshop (if needed) to ensure that it remains relevant and up-to-date. See our submission guidelines for more information.","title":"Write for the Future"},{"location":"workshop-guidelines/#specific-writing-guidelines","text":"This section contains specific guidelines for writing content for DHRIFT workshops. Please review these guidelines before and after you write your workshop content. When using coding terms or syntax in written paragraphs, use backticks ( `foo` ) to indicate they are code. When using code blocks, use triple backticks ( ``` ) to enclose the code block. For example: python def hello_world(): print(\"Hello, World!\") Use headings and subheadings to organize your content. Level 1 headings ( # ) should be used for main sections, level 2 headings ( ## ) for subsections that you want to to be visible in the table of contents, and level 3 headings ( ### ) for subsections that you want to use for readability but be hidden in the table of contents. Use quotes to highlight key points, definitions, or examples. Quotes should be formatted as follows: markdown > This is a quote. Use lists (bulleted or numbered) to break up text and make it easier to read. Lists should be formatted as follows: ```markdown This is a bulleted list item. This is another bulleted list item. markdown This is a numbered list item. This is another numbered list item. ```","title":"Specific Writing Guidelines"},{"location":"workshop-guidelines/#content-formatting-guidelines","text":"","title":"Content Formatting Guidelines"},{"location":"workshopanatomy/","text":"Anatomy of a DHRIFT Workshop # DHRIFT workshops follow a structured style sheet based on years of experience teaching DH workshops. This entry describes how DHRIFT Workshops are organized, including required and optional elements, etc. Workshop Title # Title : Choose a descriptive and engaging title for your workshop that clearly communicates the topic and content to participants. Workshop Description # Description : Provide a brief overview of the workshop content, objectives, and learning outcomes. The description should be clear, concise, and engaging to attract participants. Workshop Duration # Duration : Determine the length of your workshop based on the content and learning objectives. Workshops can range from 1-3 hours, half-day, full-day, or multi-day events. Learning Objectives # Objectives : Define clear and measurable learning objectives for your workshop. Participants should understand what they will learn and achieve by the end of the workshop.","title":"Anatomy of a Workshop"},{"location":"workshopanatomy/#anatomy-of-a-dhrift-workshop","text":"DHRIFT workshops follow a structured style sheet based on years of experience teaching DH workshops. This entry describes how DHRIFT Workshops are organized, including required and optional elements, etc.","title":"Anatomy of a DHRIFT Workshop"},{"location":"workshopanatomy/#workshop-title","text":"Title : Choose a descriptive and engaging title for your workshop that clearly communicates the topic and content to participants.","title":"Workshop Title"},{"location":"workshopanatomy/#workshop-description","text":"Description : Provide a brief overview of the workshop content, objectives, and learning outcomes. The description should be clear, concise, and engaging to attract participants.","title":"Workshop Description"},{"location":"workshopanatomy/#workshop-duration","text":"Duration : Determine the length of your workshop based on the content and learning objectives. Workshops can range from 1-3 hours, half-day, full-day, or multi-day events.","title":"Workshop Duration"},{"location":"workshopanatomy/#learning-objectives","text":"Objectives : Define clear and measurable learning objectives for your workshop. Participants should understand what they will learn and achieve by the end of the workshop.","title":"Learning Objectives"}]} \ No newline at end of file diff --git a/search/worker.js b/search/worker.js new file mode 100644 index 0000000..8628dbc --- /dev/null +++ b/search/worker.js @@ -0,0 +1,133 @@ +var base_path = 'function' === typeof importScripts ? '.' : '/search/'; +var allowSearch = false; +var index; +var documents = {}; +var lang = ['en']; +var data; + +function getScript(script, callback) { + console.log('Loading script: ' + script); + $.getScript(base_path + script).done(function () { + callback(); + }).fail(function (jqxhr, settings, exception) { + console.log('Error: ' + exception); + }); +} + +function getScriptsInOrder(scripts, callback) { + if (scripts.length === 0) { + callback(); + return; + } + getScript(scripts[0], function() { + getScriptsInOrder(scripts.slice(1), callback); + }); +} + +function loadScripts(urls, callback) { + if( 'function' === typeof importScripts ) { + importScripts.apply(null, urls); + callback(); + } else { + getScriptsInOrder(urls, callback); + } +} + +function onJSONLoaded () { + data = JSON.parse(this.responseText); + var scriptsToLoad = ['lunr.js']; + if (data.config && data.config.lang && data.config.lang.length) { + lang = data.config.lang; + } + if (lang.length > 1 || lang[0] !== "en") { + scriptsToLoad.push('lunr.stemmer.support.js'); + if (lang.length > 1) { + scriptsToLoad.push('lunr.multi.js'); + } + if (lang.includes("ja") || lang.includes("jp")) { + scriptsToLoad.push('tinyseg.js'); + } + for (var i=0; i < lang.length; i++) { + if (lang[i] != 'en') { + scriptsToLoad.push(['lunr', lang[i], 'js'].join('.')); + } + } + } + loadScripts(scriptsToLoad, onScriptsLoaded); +} + +function onScriptsLoaded () { + console.log('All search scripts loaded, building Lunr index...'); + if (data.config && data.config.separator && data.config.separator.length) { + lunr.tokenizer.separator = new RegExp(data.config.separator); + } + + if (data.index) { + index = lunr.Index.load(data.index); + data.docs.forEach(function (doc) { + documents[doc.location] = doc; + }); + console.log('Lunr pre-built index loaded, search ready'); + } else { + index = lunr(function () { + if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) { + this.use(lunr[lang[0]]); + } else if (lang.length > 1) { + this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility + } + this.field('title'); + this.field('text'); + this.ref('location'); + + for (var i=0; i < data.docs.length; i++) { + var doc = data.docs[i]; + this.add(doc); + documents[doc.location] = doc; + } + }); + console.log('Lunr index built, search ready'); + } + allowSearch = true; + postMessage({config: data.config}); + postMessage({allowSearch: allowSearch}); +} + +function init () { + var oReq = new XMLHttpRequest(); + oReq.addEventListener("load", onJSONLoaded); + var index_path = base_path + '/search_index.json'; + if( 'function' === typeof importScripts ){ + index_path = 'search_index.json'; + } + oReq.open("GET", index_path); + oReq.send(); +} + +function search (query) { + if (!allowSearch) { + console.error('Assets for search still loading'); + return; + } + + var resultDocuments = []; + var results = index.search(query); + for (var i=0; i < results.length; i++){ + var result = results[i]; + doc = documents[result.ref]; + doc.summary = doc.text.substring(0, 200); + resultDocuments.push(doc); + } + return resultDocuments; +} + +if( 'function' === typeof importScripts ) { + onmessage = function (e) { + if (e.data.init) { + init(); + } else if (e.data.query) { + postMessage({ results: search(e.data.query) }); + } else { + console.error("Worker - Unrecognized message: " + e); + } + }; +} diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 0000000..0f8724e --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,3 @@ + +This text will cover approaches to teaching with the workshops and the DHRIFt features.
+ +DHRIFT (Digital Humanities Resource Infrastructure for Teaching Technology) is an open educational resource (OER) and publication platform for digital humanities (DH) workshops. Designed by humanities scholars for humanities scholars, DHRIFT provides a minimal computing, accessibility-aware, and interactive environment for teaching fundamental DH concepts.
+The platform includes a core set of more than 10 reviewed and tested workshops that have been developed and tested during two NEH-funded, week-long institutes, called the Digital Humanities Research Institutes (DHRI). Workshop topics range from learning the basics of Python, JavaScript, and R to conducting research through text analysis, data wrangling, and mapping. You can see the full list of workshops on the workshops page, accessible from the header menu or by clicking here.
+DHRIFT’s core workshops are always accessible from and usable on our website; however, its flexible framework also allows users to build their own customized, static DHRIFT sites and tailor them for a variety of situations, such as teaching an undergraduate or graduate class, hosting a week-long skills institute, or organizing a series of professional development workshops. DHRIFT facilitates an instructor or organizations’ ability to reproduce, adapt, and publish DH workshops with interactive, learner-focused features. All workshop content is accessible in the browser, avoiding the need for learners to install software or set up complex computing environments.
+While we realize everyone learns differently and no one tool can solve for the wide variety of possible hurdles for teaching and learning digital skills, DHRIFT is designed to be flexible. We have found that it can be useful in remote, in-person, and self-instructional modalities. It is designed to be accessible to learners of all backgrounds and skill levels, from beginners to more advanced users, but our content tends toward beginners. Whether you're new to digital humanities or an experienced practitioner, DHRIFT has something to offer you.
+ +These guidelines have been prepared to help you develop effective and engaging workshops for the DHRIFT platform. By following these guidelines, you can ensure that your workshop aligns with best pedagogical practices.
+While you are free to develop workshops on any topic related to digital humanities research and teaching, if you would like to propose a workshop for inclusion in the DHRIFT core curriculum, please review these guidelines first to ensure that your workshop meets our standards for quality, accessibility, and engagement.
+As you flesh out your workshop idea, consider the following questions to create an effective and engaging learning experience:
+DHRIFT workshops are not typically lecture-based but are designed to be interactive and hands-on. Reviewing the interactive features available in the DHRIFT platform can help prepare you for how you might structure your content and assess participant learning.
+In general, DHRIFT workshops work best when: + - Your tone is formal but accessible, engaging, and inclusive. DHRIFT workshops should reflect the values of bias-free language and inclusive pedagogy. You can read more about writing with inclusive language in the APA Style Guide. + - They are created with a variety of teaching modalities in mind. DHRIFT workshops should be accessible to a wide range of learners, from in-person to online. Consider how you might adapt your content for different learning environments. + - Your content is clear, concise, and engaging. DHRIFT workshops should be easy to follow and understand, with clear instructions and explanations. Use examples, case studies, and activities to illustrate key concepts and engage participants. Keep in mind that technical jargon should be thoroughly explained and reinforced throughout the workshop. + - Your lessons are well-organized and structured. DHRIFT workshops should follow a logical sequence of topics and activities, with clear transitions between sections. Use headings, subheadings, and bullet points to break up text and make it easier to read. Keep in mind this is a participatory workshop, not a lecture or an academic paper.
+DHRIFT workshops are open-source and open-access, meaning that they are freely available to the public and can be reused, remixed, and redistributed under a Creative Commons license.TODO: what kind? By contributing to the DHRIFT platform, you agree to share your work with the wider community of digital humanities researchers and educators.
+When developing your workshop, keep in mind that your content will be shared with a diverse audience of learners, from students and scholars to professionals and enthusiasts. Make sure that your content is accessible, inclusive, and engaging to a wide range of participants. Follow these global-facing guidelines to ensure that your workshop is welcoming and respectful to all learners:
+- Use inclusive language that is free from bias, stereotypes, and discrimination.
+- Cultural references should be given context or explained. Assume that your audience is not familiar with specific cultural references.
+- Avoid using regional humor or sarcasm that may be misinterpreted or offensive.
+- Use images, examples, and case studies that reflect the diversity of the global community.
+- When referencing geographic locations, be specific: use the full name of the location (e.g., United States instead of US) to avoid confusion.
+- Be mindful when using racial or ethnic language. Historic terms no longer in use should be used only in their historical context and only when necessary.
+- Avoid using gendered language when possible.
+DHRIFT workshops should ideally be relevant and useful to participants for years to come. When developing your workshop, consider how you can future-proof your content by:
+- Note what version of software or tools you are using. If possible, use the most recent version and provide instructions for updating or adapting to future versions.
+- Reduce reliance on screenshots or images that may change over time (e.g., user interfaces, websites).
+- Pointing to external resources or documentation for tools or technologies that may change frequently.
+- Use open data sources or datasets that are freely available and accessible to all participants. Include them in your workshop materials or provide links to where they can be accessed.
+If you are submitting a workshop to our core curriculum, it is likely we will ask you to update your workshop (if needed) to ensure that it remains relevant and up-to-date. See our submission guidelines for more information.
+This section contains specific guidelines for writing content for DHRIFT workshops. Please review these guidelines before and after you write your workshop content.
+`foo`) to indicate they are code.```) to enclose the code block. For example:
+ python
+ def hello_world():
+ print("Hello, World!")#) should be used for main sections, level 2 headings (##) for subsections that you want to to be visible in the table of contents, and level 3 headings (###) for subsections that you want to use for readability but be hidden in the table of contents.markdown
+ > This is a quote.DHRIFT workshops follow a structured style sheet based on years of experience teaching DH workshops. This entry describes how DHRIFT Workshops are organized, including required and optional elements, etc.
+