Domino Projects help you follow best practices in your work. They are flexible and can fit your organization’s workflow. From idea creation to production, Projects support you through the entire process of making different analytical assets.
We have collected a series of best practices to help you succeed in creating and managing your Domino Projects.
Here is a compilation of best practices for effective data management in Projects:
Use Git-based Projects whenever possible
Git-based Projects provide enhanced control over code synchronization, allowing you to use features from external Git providers and offer a more modern development experience.
Reason: Git-based Projects help keep your repository organized so you can follow best practices for your field.
Solution: Follow these ideas for using Git-based Projects:
-
Use Git-based Projects for greater control over code synchronization.
-
Leverage features from external Git providers to improve the development experience.
Use data sources or external data volumes
Data sources in a Domino deployment have a global scope and are accessible to anyone with the appropriate permissions in any project.
Reason: Domino automatically generates an audit trail for its data sources, allowing you to track and review all activities related to those data sources.
Solution: Use these tips to use data sources:
-
Ask your Domino administrator to create, configure, and manage your data sources.
-
Use a set of fixed login details that are automatically used for all users who have permission to access a specific data source.
Domino Projects help you follow best practices and adapt to your organization’s workflow, supporting you from idea creation to production of analytical assets. Here is a collection of best practices for creating Domino projects:
Use Project templates to get started quickly
You can create Project templates that can be shared across the organization, which allows users to kickstart their Projects from an existing prototype rather than starting from scratch.
Reason: Projects often lack consistency between them, causing slower project setups and less adherence to best practices. Users can get started quickly by using existing templates rather than beginning from scratch.
Solution: Here are some ideas for using Project templates:
-
Create Project templates tailored to specific use cases.
-
Use templates to implement internal best practices or enforce company standards.
-
Foster stronger collaboration, faster project setup, and increase consistency between Projects by using a template.
Create new Projects by cloning existing Projects
Before you start your Project, look for existing content in your organization that you can use to get started.
Reason: Projects created by others in Domino can help you reach your analytical goals faster.
Solution: Follow these tips to clone existing Projects:
-
Search your Domino deployment to discover Domino Projects that you can base your Project on.
-
On your Projects home page, explore the various tabs to see Projects that you are assigned as a collaborator, as well as other Projects recommended by Domino.
-
Rename your cloned projects something different from the original to avoid confusion.
Domino makes it easy to collaborate on Projects and share outputs. Here is a collection of best practices to help you collaborate on Domino Projects:
Invite the original project owner to collaborate
The original project owner can often guide you on ways to get the most out of the cloned Project.
Reason: Complicated Projects are frequently more difficult to ramp up.
Solution: To invite the original project owner to your Project:
-
Make the original project owner a contributor to your Project.
-
Contributors can read and write project environment variables, and they can invite new collaborators.
-
Use suggestions from the original project owner for best practices for compliance.
Use individual forks for each project contributor
Forking a Project helps you stay organized and track changes if you have many contributors to a Project.
Reason: If you have many collaborators on a Project, forking the Project into a smaller copy will ensure that collaborators are contributing consistently to a Project.
Solution: Here are some reasons for using forked Projects:
-
Fork a Project to create copies of its files into a new, separate Project.
-
Changes in the forked Project can later be reviewed and merged back into the original Project.
To allow others to access a Project, you can add them as collaborators. You must be a contributor or the project owner to add collaborators.
Audit Project permissions regularly
Verify that the right collaborators have the correct permissions regularly.
Reason: Allowing anyone to find, use, or run code on your Projects can be dangerous.
Solution: Keep your Project permissions locked down:
-
Audit collaborators regularly to verify permissions.
-
Keep permissions on your Project as locked down as possible.
-
Verify that users have the needed permissions to work on your Project.
-
Use the Visibility setting to specify who can view your Project.
-
Create a Project to help you follow best practices in your work. Projects are flexible and can fit your organization’s workflow and support you through the entire process of creating different analytical assets.
-
Copy a Project to create a duplicate of an existing Project, which does not include Project settings, run history, or scheduled Jobs.
-
Import Git repositories into your Project to access the repository and commit changes to repository contents.
-
Export and import Project content shows you how to share content among Projects by exporting and importing.