openmainframeproject / wg-modernization

Modernization WG
Creative Commons Attribution 4.0 International
5 stars 4 forks source link

Define a folder structure #9

Open ijmitch opened 1 year ago

ijmitch commented 1 year ago

The repository needs to be navigable and consumable by readers.

The need here is to define a set of principles for the hierarchy of folders to clearly segment the content.

Whilst the majority of the content might be Markdown, we will accommodate other asset formats as appropriate.

ijmitch commented 1 year ago

Of course, it's possible to define an initial set of folders in a branch/PR for discussion.

skriesch commented 1 year ago

Here is explained, how to link md files within a Github repository: https://github.blog/2013-01-31-relative-links-in-markup-files/

A tree structure is a good idea.

MistyDecker commented 1 year ago

Some ideas to start...

Application Modernization: • Code analysis for planning • Refactor monolithic applications • Unlock application value through APIs • integrate with other modern languages • Leverage managed services (XaaS) such as databases, analytics and storage

Process Modernization: • Move to modern source code management systems • Implement Agile practices • Implement DevSecOps • Adopt modern development tools • Automate unit testing • Implement DevOps • Adopt CI/CD

Infrastructure Modernization: • Target containers and orchestration for reliable and faster application delivery • Re-platform applications to commodity x86 hardware • Use containerization and Infrastructure as Code • Implement a multi-cloud model • Migrate COBOL and mainframe applications to the cloud • Use virtualized and containerized platforms

ijmitch commented 1 year ago

I was really intending this issue to solely consider the shape of the folder structure to accommodate topics, rather than define the content/topics to be accommodated.

But I guess we could have a go at doing both and see how it goes.

pwmccaffrey commented 1 year ago

I'd like to be more generic in the folder structure e.g. Definition, Framework, ... I'm not on board with something like Application, Process, Infrastructure yet because it implies there is agreement with that kind of definition. Don't think we are there yet.

rpomp commented 1 year ago

agree with @pwmccaffrey and @ijmitch above assumes scope agreement, lets focus on work/process content structure. so @ijmitch are you looking for content category bill of materials? ie, guidebook, roadmap, code snippets, architecture, best practices, blah blah?

gmackinnon commented 1 year ago

agree with @rpomp et al.

MistyDecker commented 9 months ago

There are a number of things on @rpomp’s list that hadn’t occurred to me. How about we start by collecting some examples of what people think should be in the repository? I’ll start a separate issue just to collect some ideas and then we can draft an INITIAL structure out of that. Remember that this is our first take on a structure. Nothing says we can’t decide two months from now or a year from now that another structure will work better.