Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add development plan document #344

Merged
merged 2 commits into from
May 17, 2024
Merged

Conversation

joergroedel
Copy link
Member

No description provided.

Remove these sections as they are out-of-date anyway and always hard
to keep in sync with the development work.

Signed-off-by: Joerg Roedel <jroedel@suse.de>
@roy-hopkins
Copy link
Collaborator

The document should also be added to the navigation list in mkdocs.yml. Something like:

diff --git a/Documentation/mkdocs.yml b/Documentation/mkdocs.yml
index 94d33b9..884c632 100644
--- a/Documentation/mkdocs.yml
+++ b/Documentation/mkdocs.yml
@@ -9,6 +9,7 @@ nav:
 
   - Developer Information:
     - 'developer/DOC-GUIDELINES.md'
+    - 'developer/DEVELOPMENT-PLAN.md'
     - Rustdoc Guidelines: 'developer/RUSTDOC-GUIDELINES.md'
     - Fuzzing: 'developer/FUZZING.md'
     - Contributing to COCONUT-SVSM: 'developer/CONTRIBUTING.md'

Add a document which lists in-progress and future development items
for the COCONUT-SVSM project.

Signed-off-by: Joerg Roedel <jroedel@suse.de>
@joergroedel
Copy link
Member Author

The document should also be added to the navigation list in mkdocs.yml. Something like:

diff --git a/Documentation/mkdocs.yml b/Documentation/mkdocs.yml
index 94d33b9..884c632 100644
--- a/Documentation/mkdocs.yml
+++ b/Documentation/mkdocs.yml
@@ -9,6 +9,7 @@ nav:
 
   - Developer Information:
     - 'developer/DOC-GUIDELINES.md'
+    - 'developer/DEVELOPMENT-PLAN.md'
     - Rustdoc Guidelines: 'developer/RUSTDOC-GUIDELINES.md'
     - Fuzzing: 'developer/FUZZING.md'
     - Contributing to COCONUT-SVSM: 'developer/CONTRIBUTING.md'

Right, thanks. Added the link to this file as well.

@joergroedel joergroedel merged commit fc98243 into coconut-svsm:main May 17, 2024
3 checks passed
@joergroedel joergroedel deleted the dev-plan branch May 17, 2024 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants