Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ For detailed information about the project:

### 🌐 Documentation in Other Languages

- **[πŸ‡§πŸ‡· PortuguΓͺs (Brasil)](docs/pt-BR/)** - DocumentaΓ§Γ£o em portuguΓͺs _(em desenvolvimento)_
- **[πŸ‡ͺπŸ‡Έ EspaΓ±ol](docs/es/)** - DocumentaciΓ³n en espaΓ±ol _(en desarrollo)_
- **[πŸ‡§πŸ‡· PortuguΓͺs (Brasil)](docs/pt-BR/)** - DocumentaΓ§Γ£o em portuguΓͺs
- **[πŸ‡ͺπŸ‡Έ EspaΓ±ol](docs/es/)** - DocumentaciΓ³n en espaΓ±ol

_Want to help translate the documentation? Check our [contribution guide](docs/CONTRIBUTING.md#internationalization)!_

Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Welcome to the StackCode documentation hub! This directory contains comprehensiv

### 🌐 **Translations**

- **[πŸ‡§πŸ‡· PortuguΓͺs (Brasil)](pt-BR/)** - DocumentaΓ§Γ£o em portuguΓͺs _(em desenvolvimento)_
- **[πŸ‡ͺπŸ‡Έ EspaΓ±ol](es/)** - DocumentaciΓ³n en espaΓ±ol _(en desarrollo)_
- **[πŸ‡§πŸ‡· PortuguΓͺs (Brasil)](pt-BR/)** - DocumentaΓ§Γ£o em portuguΓͺs
- **[πŸ‡ͺπŸ‡Έ EspaΓ±ol](es/)** - DocumentaciΓ³n en espaΓ±ol

## 🎯 **Documentation by Audience**

Expand Down
114 changes: 22 additions & 92 deletions docs/SELF_HOSTING_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,27 +114,22 @@ docker run -it your-org/stackcode init
export type SupportedStack = "node-js" | "react" | "your-custom-stack"; // Add your stack
```

### Configuration Customization
### Basic Configuration

1. **Default Configuration**
StackCode supports a simple `.stackcoderc.json` configuration file to set project defaults:

```json
// Create .stackcoderc in your users' home directories
{
"defaultAuthor": "Your Organization",
"defaultLicense": "Proprietary",
"organizationTemplates": true,
"privateRegistry": "https://your-npm-registry.com"
}
```
```json
// .stackcoderc.json (in project root)
{
"features": {
"commitValidation": true
}
}
```

2. **Environment Variables**
```bash
# Set organization defaults
export STACKCODE_DEFAULT_AUTHOR="Your Organization"
export STACKCODE_PRIVATE_REGISTRY="https://your-npm-registry.com"
export STACKCODE_TEMPLATE_PATH="/path/to/custom/templates"
```
This configuration currently supports:

- `commitValidation`: Enable/disable conventional commit validation

### Internationalization

Expand All @@ -154,62 +149,6 @@ echo '{"welcome": "Willkommen"}' > packages/i18n/src/locales/de.json
2. **Dependency Scanning**: Regularly scan dependencies for vulnerabilities
3. **Access Control**: Restrict who can modify templates and configurations

### Network Security

1. **Private Registries**: Use private NPM registries for internal packages
2. **VPN Access**: Require VPN for accessing internal StackCode instances
3. **Audit Logging**: Log all template generations and modifications

### Template Security

1. **Sanitize Inputs**: Validate all user inputs in templates
2. **Restrict File Access**: Limit template file system access
3. **Code Review Templates**: Review all custom templates for security issues

## πŸ”„ Update Management

### Versioning Strategy

1. **Semantic Versioning**: Follow semver for your organization's version
2. **Release Notes**: Maintain detailed changelog for internal releases
3. **Testing Pipeline**: Test all changes before deploying to teams

### Update Process

```bash
# Update from upstream
git remote add upstream https://github.com/YagoBorba/StackCode.git
git fetch upstream
git merge upstream/develop

# Review changes and test
npm test
npm run build

# Deploy to your organization
npm publish --registry https://your-npm-registry.com
```

## πŸ—οΈ Architecture for Organizations

### Centralized Configuration

```
Organization Setup:
β”œβ”€β”€ stackcode-config/
β”‚ β”œβ”€β”€ templates/ # Custom organization templates
β”‚ β”œβ”€β”€ configs/ # Default configurations
β”‚ └── policies/ # Development policies
β”œβ”€β”€ private-registry/ # Internal NPM registry
└── deployment/ # Deployment scripts
```

### Team Integration

1. **Team Templates**: Create templates specific to different teams
2. **Approval Workflows**: Implement approval processes for new templates
3. **Usage Analytics**: Track template usage across teams

## πŸ› οΈ Troubleshooting

### Common Issues
Expand All @@ -232,33 +171,24 @@ Organization Setup:
ls packages/core/dist/templates/
```

3. **Registry Issues**
3. **Build Issues**

```bash
# Check registry configuration
npm config get registry
# Check if templates are properly copied
npm run build
ls packages/core/dist/templates/

# Test registry connectivity
npm ping --registry https://your-registry.com
# Verify build output
npm test
```

### Support and Maintenance

1. **Internal Documentation**: Maintain organization-specific documentation
2. **Support Channels**: Set up internal support channels for StackCode issues
3. **Regular Updates**: Schedule regular updates from the upstream repository

## πŸ“‹ Deployment Checklist

- [ ] Repository forked and customized
- [ ] Custom templates created and tested
- [ ] Configuration files distributed to teams
- [ ] Private registry configured (if applicable)
- [ ] Security review completed
- [ ] Team training conducted
- [ ] Monitoring and logging set up
- [ ] Update process documented
- [ ] Support process established
- [ ] Build process completed successfully
- [ ] Tests passing
- [ ] Documentation updated for customizations

## 🀝 Contributing Back

Expand Down
66 changes: 1 addition & 65 deletions docs/es/SELF_HOSTING_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,71 +146,7 @@ echo '{"welcome": "Bienvenido"}' > packages/i18n/src/locales/es.json
echo '{"welcome": "Willkommen"}' > packages/i18n/src/locales/de.json
```

## πŸ”’ Security Considerations

### Code Review Process

1. **Fork and Review**: Always fork the repository and review changes
2. **Dependency Scanning**: Regularly scan dependencies for vulnerabilities
3. **Access Control**: Restrict who can modify templates and configurations

### Network Security

1. **Private Registries**: Use private NPM registries for internal packages
2. **VPN Access**: Require VPN for accessing internal StackCode instances
3. **Audit Logging**: Log all template generations and modifications

### Template Security

1. **Sanitize Inputs**: Validate all user inputs in templates
2. **Restrict File Access**: Limit template file system access
3. **Code Review Templates**: Review all custom templates for security issues

## πŸ”„ Update Management

### Versioning Strategy

1. **Semantic Versioning**: Follow semver for your organization's version
2. **Release Notes**: Maintain detailed changelog for internal releases
3. **Testing Pipeline**: Test all changes before deploying to teams

### Update Process

```bash
# Update from upstream
git remote add upstream https://github.com/YagoBorba/StackCode.git
git fetch upstream
git merge upstream/develop

# Review changes and test
npm test
npm run build

# Deploy to your organization
npm publish --registry https://your-npm-registry.com
```

## πŸ—οΈ Architecture for Organizations

### Centralized Configuration

```
Organization Setup:
β”œβ”€β”€ stackcode-config/
β”‚ β”œβ”€β”€ templates/ # Custom organization templates
β”‚ β”œβ”€β”€ configs/ # Default configurations
β”‚ └── policies/ # Development policies
β”œβ”€β”€ private-registry/ # Internal NPM registry
└── deployment/ # Deployment scripts
```

### Team Integration

1. **Team Templates**: Create templates specific to different teams
2. **Approval Workflows**: Implement approval processes for new templates
3. **Usage Analytics**: Track template usage across teams

## πŸ› οΈ Troubleshooting
## ️ Troubleshooting

### Common Issues

Expand Down
Loading