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.

Sign up for GitHub

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

Jump to bottom

AgroPortal documentation consolidation and new documentation #162

Open
7 of 23 tasks
syphax-bouazzouni opened this issue Dec 27, 2021 · 2 comments
Open
7 of 23 tasks

AgroPortal documentation consolidation and new documentation #162

syphax-bouazzouni opened this issue Dec 27, 2021 · 2 comments
Assignees
@jonquet @syphax-bouazzouni
Labels
documentation project managment issues used as development tasks in our projects

Comments

@syphax-bouazzouni
Copy link
Contributor

syphax-bouazzouni commented Dec 27, 2021 •
edited
Loading

Here are my work notes and report about Documentation implementation: https://stageportal.notion.site/Write-technical-documentation-Report-4cb216c9c9cf4fd8a6e4d7684d300176

This issue is to discuss and follow our work in upgrading our intern docs.
Current mind map about the doc is here: https://mm.tt/map/2133916968?t=2m8GFO6uTe

image

Plan

Select and deploy a documentation tool

Topic to document

We need to document the following subjects : @jonquet insert here your needs/ideas.

  • How to setup a local development environment (type: dev)
  • How we deploy our projects (type: devops)
  • What are our products/services (type: functional)
  • What is our application architecture (type: dev)
  • What is our technical architecture (type: devops)
  • What is our development workflow (type: dev)
  • Where to find our logs and how to read them (type: admin, dev, devops)
  • How to configure our apps (type: admin, dev)
  • How to test our apps (type: dev, devops)
  • How to read our doc (type: functional)
  • How to write in our doc (our policies) (type: admin)
  • How to process ontologies (type: admin)
  • How is the ontology process working (type: dev, functional)

Remove/Archive all the old docs

  • Move the GitHub Wiki content to new Outline and archive GitHub wiki
  • Refresh the moved pages on the new wiki
  • Move documentation from Google Drive to Outline wiki
  • Update the OntoPortal literature repository content
  • Move doc from gite.lirmm.fr

Remove/Archive all the old docs
@syphax-bouazzouni syphax-bouazzouni mentioned this issue Dec 27, 2021
Closed
17 tasks
@syphax-bouazzouni syphax-bouazzouni added the project managment issues used as development tasks in our projects label Dec 27, 2021
@syphax-bouazzouni syphax-bouazzouni changed the title New documentation management New documentation Jan 6, 2022
@syphax-bouazzouni syphax-bouazzouni mentioned this issue Feb 14, 2022
Closed
35 tasks
@syphax-bouazzouni syphax-bouazzouni mentioned this issue Jun 16, 2022
Closed
57 tasks
@syphax-bouazzouni syphax-bouazzouni mentioned this issue Sep 12, 2022
Closed
57 tasks
@jonquet
Copy link
Contributor

jonquet commented Nov 17, 2022

Archived project-management wiki and disabled other un-used GitHub features.

@jonquet jonquet changed the title New documentation AgroPortal documentation consolidation and new documentation Nov 17, 2022
@syphax-bouazzouni syphax-bouazzouni mentioned this issue Dec 28, 2022
Closed
67 tasks
@syphax-bouazzouni syphax-bouazzouni mentioned this issue May 6, 2023
Closed
34 tasks
@syphax-bouazzouni syphax-bouazzouni mentioned this issue Dec 14, 2023
Closed
31 tasks
@syphax-bouazzouni
Copy link
Contributor Author

@jonquet need to focus again on this, before migrating to https://ontoportal.github.io/documentation/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jonquet jonquet

@syphax-bouazzouni syphax-bouazzouni

Labels
documentation project managment issues used as development tasks in our projects
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jonquet @syphax-bouazzouni