Skip to content
Snippets Groups Projects
Select Git revision
  • 7b078c00e07f18a1d69a49695cadccde4cd4848c
  • main default
2 results

2022-02-12.md

Blame
  • 2022-02-12

    Big Idea

    • There are a bunch of decisions that have to be made
      1. Where to put notes
        1. Microsoft / Teams / OneNote (WYSIWYG)
        2. Gitlab / Wiki (Markdown)
        3. Repo / Docs Directory (Markdown)
        4. Repo / Obsidian Directory (Modified Markdown)
        5. Repo / Code Directory (Markdown) (Place Notes alongside code) (Requires rigor regarding linking/dating of notes)
        6. Repo / Docs Directory (ReStructured Text) (More Popular with Python projects, better formatting/structural writing)
      1. Code of Conduct
      1. Contributing Guidelines
      • Where are the discussions for this?
      1. Issue Templates
      • What formats to use? What do people find useful?
      1. Which Platform to use (EvaP or Sakai)
      • Need to ask Jeff Salvage about difficulty of maintaining adapters
      1. How to Merge Notes
      • Already scattered all over the damn place
      • Need to merge - how?
        • SE420 FA22Q2 Teams OneNote Notebook (This will probably continue to see use, especially regarding sensitive information)
        • Peter's Google Keep (In Progress Download and Transfer) (No Longer Relevant/Needed)
        • Peter's Personal Notes (In Progress Transfer) (No Longer Relevant/Needed)
        • Also bear in mind use of Discord as a "temporary notes platform"
      • Eh, for now, not of concern
      1. Required Qualities of Notes
      • What do people find useful/necessary?
      • Ability to simultaneously edit notes online at same time has been very popular recently
      • Thus promoting the use of in-browser microsoft word
      • Also note pattern of only one person taking notes
      1. Purpose of Repository
      • If direct contributions to EvaP/Sakai are intended, how to go about doing so?
      1. Who are the Notes for

    Using this File and Directory and Editor and Language for Immediate Task Resolution

    • File: 2022-02-12.md
    • Directory: team-blue/notes/
    • Editor: Visual-Studio-Code
    • Language: Standard-Markdown

    Immediate Tasks

    README

    Content License

    Conduct

    Code Contributing Guidelines

    Arch Files

    Change Logs

    Security

    Issue Templates

    Issue Tags

    Issue Management

    • Milestones
    • Boards
    • Due Dates

    Current Issues

    • What things need to immediately get done/have a physical impact?

    Misc

    New Directory Structure

    team-blue/:
      .gitlab/issue_templates/:
        bug-report.md
        class-assignment.md
        documentation.md
        external-interaction.md
        proposal.md
        team-process.md
      documents/:
        decisions/:
          0001-use-decisions-as-docs.md
        developers/:
          conduct.md # BIG how to be nice
          contributing.md # BIG contrib guidelines
          decisions.md # EXPLAIN how to make decisions
          processes.md # EXPLAIN labels, decision, how the project fits together
          discussion-template.md
          writing-changelogs.md
        discussions/:
          2022-02-12.md # a name might follow these as well
        public/:
          # anything the general public might need to see
          security.md # who to really contact
      resources/:
        team-logo.png
        drexel-logo.png
        cc-by-logo.png
      changelog.md
      credits.md
      license.md
      readme.md

    Working Style

    • Peter: For this repo (the team), branching style will probably be best style to use
    • Peter: For the external project, an entirely new repo is probably most suitable