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

Define a folder structure #9

Open
ijmitch opened this issue May 17, 2023 · 8 comments
Open

Define a folder structure #9

ijmitch opened this issue May 17, 2023 · 8 comments

Comments

@ijmitch
Copy link
Contributor

ijmitch commented May 17, 2023

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
Copy link
Contributor Author

ijmitch commented May 17, 2023

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

@skriesch
Copy link

skriesch commented May 17, 2023

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
Copy link
Collaborator

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
Copy link
Contributor Author

ijmitch commented May 18, 2023

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
Copy link

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
Copy link

rpomp commented May 19, 2023

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
Copy link

agree with @rpomp et al.

@MistyDecker
Copy link
Collaborator

MistyDecker commented Sep 27, 2023

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.

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

No branches or pull requests

6 participants