Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!

Objective:

Migrate our existing GitHub Pages website to Quarto to utilize its advanced features and improve site functionality.

Key Tasks:

• Convert current markdown/HTML content to Quarto format.
• Maintain existing URL structure for smooth transition.
• Redesign site using Quarto’s styling options.
• Update project documentation with new workflow.

What type of pull request would this be?

Enhancement

Any links to similar examples or other references we should review?

• maehr/academic-pandoc-template#38

Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!

Background

The project currently uses a CC BY 4.0 license, which is excellent for data and documentation. However, for the codebase, a more appropriate license like AGPL could provide better protection and clarity.

Suggested Changes

1. Add a new LICENSE-AGPL file in the root directory, specifying that the code is licensed under AGPL.
2. Update the README.md to mention the dual licensing strategy.
3. Update any headers in source code files to reflect the dual license.

Benefits

• AGPL offers better protection against proprietary use of the code.
• Dual licensing provides clarity on how different project components can be used.

Tasks

• Add LICENSE-AGPL with AGPL text.
• Update README.md.
• Update source code headers.

What type of pull request would this be?

Enhancement

Any links to similar examples or other references we should review?

No response

Current Behavior

The URL mentioned in codelist.txt is not accessible. It currently contains a TODO with a URL to Eurostat's metadata code lists.

Reproduction / Steps To Reproduce

1. Navigate to the docs folder.
2. Open codelist.txt.
3. See the TODO and inaccessible URL.

Anything else?

Suggested Changes

1. Replace the TODO and URL in codelist.txt with summarized content from Eurostat's Code Lists.
2. Include a reference to the Eurostat page for further details.

Content to Include

• Briefly describe what code lists are and their importance in statistical data.
• Mention that Eurostat uses around 600 code lists for various dimensions like age, sex, geo, time, and unit.
• Highlight the ongoing standardization efforts by Eurostat.

Benefits

• Provides a more informative and accessible resource for code lists.
• Aligns with reputable sources like Eurostat for metadata standards.

Tasks

• Update codelist.txt with summarized content from Eurostat.
• Add a reference to the Eurostat page.

Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!

Background

The project currently follows best practices for open data as outlined in The Turing Way. To further align with national guidelines, it would be beneficial to include information from the Swissuniversities National Strategy and Action Plan for Open Research Data.

Suggested Changes

1. Add a new section in the README.md under "How this template helps you" to discuss the Swissuniversities guidelines.
2. Include a hyperlink to the Swissuniversities page for readers to get more detailed information.
3. Briefly summarize the key points from the Swissuniversities guidelines that are relevant to the project.

Benefits

• Aligns the project with national guidelines on open research data.
• Provides additional context and resources for users interested in Swiss-specific guidelines.

Tasks

• Update README.md to include a new section about Swissuniversities guidelines.
• Add hyperlink to Swissuniversities page.
• Summarize key points from Swissuniversities guidelines.

What type of pull request would this be?

Docs

Any links to similar examples or other references we should review?

No response

Link to the Page

https://maehr.github.io/open-research-data-template/

Describe the Issue

I get a 404 on

• Templates for reporting data issues using a custom template

Are you able to create a Pull Request with the fix?

Yes

Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!

Steps to Implement:

1. Create a .zenodo.json file to specify metadata. See https://developers.zenodo.org/#add-metadata-to-your-github-repository-release
2. Connect the GitHub repository to Zenodo.
3. Trigger the archive process on Zenodo.

Expected Benefits:

• Long-term data preservation
• Academic citability via DOI
• Increased visibility and credibility

What type of pull request would this be?

None

Any links to similar examples or other references we should review?

No response

Describe what feature you'd like. Pseudo-code, mockups, or screenshots of similar solutions are encouraged!

Renaming this project with a more clear scope would help users to grasp its purpose faster (I hope).

To change the name of your GitHub repository from open-data-template to open-research-data-template, you can follow these steps:

1. Go to the Repository Settings:

   • Visit the current repository URL: https://github.com/maehr/open-data-template/
   • Make sure you are logged into your GitHub account.

2. Click on "Settings":

   • On the right-hand side, you'll see a menu. Click on "Settings" near the bottom.

3. Change the Repository Name:

   • Under the "Repository Name" section, you'll see your current repository name (open-data-template).
   • Click on the current repository name to edit it.

4. Enter the New Name:

   • Replace open-data-template with open-research-data-template.

5. Update References:

   • GitHub will check if the new name is available. If it is, you will see a green checkmark.
   • Scroll down and make sure to check the box that says "I understand, update the references."

6. Confirm Changes:

   • Click on the "Rename" button to confirm the name change.

7. Update Your Local Git Repository (if applicable):

   • If you have a local clone of the repository, you'll need to update its remote URL. You can do this using the following command:

     git remote set-url origin https://github.com/maehr/open-research-data-template.git
     

   • Replace the URL with the new repository URL.

8. Update Website URL:

   • If you have a GitHub Pages website associated with the repository, you may need to update the URL in your repository settings to point to the new name:
     • Go to "Settings" > "Pages."
     • Update the source branch or folder to match the new repository name (e.g., main or /docs).

Caveats:

• Changing the repository name will update all references within GitHub, including issues, pull requests, forks, and links. However, external links to your repository may break, so you should update those as well.
• If you have any automated workflows, CI/CD configurations, or scripts that reference the old repository name, you'll need to update them to use the new name.
• Ensure that any collaborators or contributors are informed about the name change to avoid confusion.

Once you've completed these steps, your repository should have the new name, and the URL for your GitHub Pages website should also reflect the change.

Remember to update any references to the old name in your documentation, README, or other relevant places to avoid confusion for users and collaborators.

Please note that this process should be handled with caution, especially if your repository is widely used, to minimize disruption to your users and contributors.

What type of pull request would this be?

Other

Any links to similar examples or other references we should review?

No response