Haddock

Edit Project

Overview

Haddock allows you to modify various aspects of your deployed projects, including the project name, description, and authorization method. These changes help you keep your project information up-to-date and manage access permissions effectively.

What You Can Edit

The following project attributes can be modified:

  • Project Name: Change the display name of your project
  • Project Description: Update the project description for better organization
  • Authorization Method: Modify the authentication method used for project deployment

Real-time Updates

Changes made to project information are immediately reflected across the platform, including the project header and dashboard listing.

Steps to Edit Project Information

1. Navigate to Project Settings

  1. Go to the view of the project you want to edit
  2. Switch from the Topology view to the Settings tab
  3. Click on the “Edit this Project” button (highlighted in purple)

2. Update Project Information

Once the edit form is open, you can modify:

Project Name

  • Update the project name field with your desired new name
  • The name will be displayed in the project header and dashboard

Project Description

  • Modify the description field to better describe your project
  • This helps with project organization and team collaboration

Authorization Method

  • Select a different authorization method if needed
  • This affects how the project handles authentication and access control

3. Save Changes

  1. After making your desired changes, click the “Edit this Project” button at the bottom of the form
  2. Wait for the system to process your changes

Visual Updates

  • The project name is immediately updated in the project page header
  • The dashboard reflects the new name and description in the project list
  • All references to the project across the platform use the updated information

Authorization Changes

  • If you modified the authorization method, a separate toast notification confirms the authorization update
  • The new authorization method takes effect immediately for future deployments

Best Practices

Project Naming

Naming Convention

  • Use clear, descriptive names that reflect the project’s purpose
  • Consider including environment information (e.g., “MyApp-Production”)
  • Avoid special characters that might cause issues with deployment

Descriptions

  • Keep descriptions concise but informative
  • Include key technologies or frameworks used
  • Mention the project’s main purpose or functionality

Authorization Methods

  • Choose the authorization method that best fits your security requirements
  • Test the new authorization method in a development environment first
  • Ensure team members are aware of authorization changes

Troubleshooting

Common Issues

Changes not saving?

  • Verify you have a stable internet connection
  • Ensure all required fields are properly filled
  • Check that the new project name doesn’t conflict with existing projects

Authorization changes not working?

  • Allow a few minutes for authorization changes to propagate
  • Test the new authorization method with a small deployment first
  • Verify the selected authorization method is compatible with your project setup

Security Considerations

  • Authorization method changes affect project security immediately
  • Ensure team members are informed of authorization updates
  • Document any changes for future reference and compliance
  • Test authorization changes in non-production environments when possible
Prev
Contributing
Next
Environment Variables Management