universalisos/IMPORT_GUIDE.md
Fábio Coutada 98fef51e93 docs(import): Add comprehensive PikeOS import guide
- Create detailed IMPORT_GUIDE.md for PikeOS ecosystem import
- Document multiple import methods (WebDAV, direct copy, manual download)
- Include validation procedures for each component
- Add troubleshooting and post-import processing steps
- Provide completion checklist for import verification

This guide facilitates the complete PikeOS import from Nextcloud
once source access is available at cloud.portugalfuturista.org/s/devmm-arch

Co-Authored-By: Claude <noreply@anthropic.com>
2026-07-06 18:01:34 +01:00

283 lines
No EOL
7.4 KiB
Markdown

# PikeOS Import Guide
This document provides detailed instructions for importing the complete PikeOS ecosystem from Nextcloud into the Universalisos repository.
## Source Material Location
**Nextcloud**: `https://cloud.portugalfuturista.org/s/devmm-arch`
**Access Methods**:
1. **Web Interface**: Direct download via browser
2. **WebDAV**: `https://cloud.portugalfuturista.org/remote.php/dav/files/USERNAME/devmm-arch/`
3. **Nextcloud Sync Client**: Configure local sync folder
4. **Direct Copy**: If files are available on local network
## Import Process
### Method 1: WebDAV/Rsync Import
If you have WebDAV access configured:
```bash
# Set up environment variables
export NEXTCLOUD_URL="https://cloud.portugalfuturista.org"
export NEXTCLOUD_USER="your-username"
export NEXTCLOUD_PASS="your-password"
export PIKEOS_SOURCE="/remote.php/dav/files/$NEXTCLOUD_USER/devmm-arch/pikeos"
# Import using cadaver (WebDAV client) or curl
sudo dnf install cadaver
# For each PikeOS component, use appropriate import method
```
### Method 2: Direct Copy (If Available Locally)
If the PikeOS source material is available on a local system or network mount:
```bash
# Set source directory
export PIKEOS_SOURCE="/path/to/devmm-arch/pikeos"
# Import source code
rsync -avz --progress \
"$PIKEOS_SOURCE/src/" \
/home/fabiorafaelcoutada/portugalfuturista/universalisos/src/
# Import test framework
rsync -avz --progress \
"$PIKEOS_SOURCE/test/" \
/home/fabiorafaelcoutada/portugalfuturista/universalisos/test/
# Import IDE source code
rsync -avz --progress \
"$PIKEOS_SOURCE/ide/" \
/home/fabiorafaelcoutada/portugalfuturista/universalisos/ide/
# Import XSD schemas
rsync -avz --progress \
"$PIKEOS_SOURCE/xsd/" \
/home/fabiorafaelcoutada/portugalfuturista/universalisos/xsd/
# Import PDF documentation
rsync -avz --progress \
"$PIKEOS_SOURCE/docs/" \
/home/fabiorafaelcoutada/portugalfuturista/universalisos/docs/
```
### Method 3: Manual Download via Web Interface
1. Access `https://cloud.portugalfuturista.org/s/devmm-arch`
2. Download the following directories as ZIP files:
- `pikeos/src/` - Source code
- `pikeos/test/` - Test framework
- `pikeos/ide/` - Eclipse IDE source code
- `pikeos/xsd/` - XSD schema files
- `pikeos/docs/` - PDF documentation
3. Extract each ZIP to the corresponding directory:
```bash
# Extract source code
unzip pikeos-src.zip -d /home/fabiorafaelcoutada/portugalfuturista/universalisos/src/
# Extract test framework
unzip pikeos-test.zip -d /home/fabiorafaelcoutada/portugalfuturista/universalisos/test/
# Extract IDE source code
unzip pikeos-ide.zip -d /home/fabiorafaelcoutada/portugalfuturista/universalisos/ide/
# Extract XSD schemas
unzip pikeos-xsd.zip -d /home/fabiorafaelcoutada/portugalfuturista/universalisos/xsd/
# Extract documentation
unzip pikeos-docs.zip -d /home/fabiorafaelcoutada/portugalfuturista/universalisos/docs/
```
## Validation After Import
### 1. Source Code Validation
```bash
cd /home/fabiorafaelcoutada/portugalfuturista/universalisos
# Verify source code structure
tree -L 3 src/
# Check for common PikeOS components
find src/ -name "*.c" -o -name "*.h" -o -name "*.cpp" | wc -l
# Validate source file integrity
find src/ -type f -name "*.c" -exec file {} \; | grep -c "C source"
```
### 2. Test Framework Validation
```bash
# Verify test framework structure
tree -L 3 test/
# Check for test files
find test/ -name "*test*.c" -o -name "*test*.cpp" | head -10
# Verify test configuration
find test/ -name "CMakeLists.txt" -o -name "Makefile"
```
### 3. XSD Schema Validation
```bash
# Validate XSD schemas
cd xsd/
for schema in *.xsd; do
echo "Validating $schema..."
xmllint --schema "$schema" --noout test.xml 2>/dev/null && echo "✓ Valid" || echo "✗ Invalid"
done
# Check XSD completeness
find xsd/ -name "*.xsd" | wc -l
```
### 4. IDE Source Code Validation
```bash
# Verify IDE structure
tree -L 3 ide/
# Check for code generation files
find ide/ -name "*codegen*" -o -name "*xsd*" -o -name "*eclipse*" | head -10
# Verify Eclipse plugin structure
find ide/ -name "plugin.xml" -o -name "MANIFEST.MF"
```
### 5. Documentation Validation
```bash
# Verify PDF documentation
find docs/ -name "*.pdf" | wc -l
# Check documentation categories
ls -la docs/
# Verify documentation integrity
file docs/*.pdf | grep -c "PDF document"
```
## Import Completion Checklist
- [ ] Source code imported successfully (`src/` directory populated)
- [ ] Test framework imported (`test/` directory populated)
- [ ] IDE source code imported (`ide/` directory populated)
- [ ] XSD schemas imported (`xsd/` directory populated)
- [ ] PDF documentation imported (`docs/` directory populated)
- [ ] All source files validated for integrity
- [ ] XSD schemas validated for well-formedness
- [ ] Test framework structure verified
- [ ] IDE code generation components identified
- [ ] Documentation accessibility confirmed
## Post-Import Processing
### 1. Initial Git Commit
```bash
cd /home/fabiorafaelcoutada/portugalfuturista/universalisos
# Add all imported files
git add src/ test/ ide/ xsd/ docs/
# Create initial import commit
git commit -m "feat(import): Complete PikeOS ecosystem import
- Import PikeOS source code from Nextcloud devmm-arch
- Import PikeOS test framework source code
- Import Eclipse-based IDE source code (XSD → C generation)
- Import XSD schema files for C/C++ code generation
- Import complete PDF documentation
Source: https://cloud.portugalfuturista.org/s/devmm-arch
Co-Authored-By: Claude <noreply@anthropic.com>"
# Push to remote repository
git push origin development
```
### 2. Compilation Test
```bash
cd src/
mkdir build && cd build
# Configure with ARM toolchain
cmake -DCMAKE_TOOLCHAIN_FILE=~/.cmake/arm-none-eabi.cmake -G Ninja ..
# Attempt compilation
ninja
# Document compilation results
cd ../..
echo "Compilation test completed: $(date)" > COMPILATION_TEST_LOG.md
```
### 3. Documentation Updates
After successful import, create additional documentation:
```bash
# Create XSD workflow analysis
# Create AUTOSAR compliance documentation
# Create component categorization
# Create hypervisor architecture documentation
# Create Aurelio integration plan
```
## Troubleshooting
### Issue: Cannot access Nextcloud
**Solution**: Check network connectivity and credentials
```bash
# Test Nextcloud connectivity
curl -I https://cloud.portugalfuturista.org
# Check if authentication is required
curl -I https://cloud.portugalfuturista.org/s/devmm-arch
```
### Issue: Import incomplete or corrupted
**Solution**: Verify checksums and re-import
```bash
# Generate checksums
find . -type f -exec sha256sum {} \; > checksums.txt
# Verify checksums after import
sha256sum -c checksums.txt
```
### Issue: Large import taking too long
**Solution**: Use incremental import with progress monitoring
```bash
# Import with progress indicator
rsync -avz --progress --stats \
"$PIKEOS_SOURCE/src/" \
/home/fabiorafaelcoutada/portugalfuturista/universalisos/src/
# Monitor disk space during import
watch -n 5 'df -h /home/fabiorafaelcoutada/portugalfuturista/'
```
## Next Steps
After completing the PikeOS import:
1. **Phase 3**: XSD Workflow Analysis (Day 8-10)
2. **Phase 4**: Safety Standards Compliance Documentation (Day 11-12)
3. **Phase 5**: Component Categorization (Day 13-14)
4. **Phase 6**: Aurelio Brain Test (Day 15)
---
**Note**: This import process requires access to the PikeOS source material. If you encounter access issues, please verify Nextcloud credentials and network connectivity.