Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "OSEE/Engineering Notebook"

 
Line 3: Line 3:
  
 
It serves the following purposes:
 
It serves the following purposes:
−
* Log of daily activities.  Useful to go back and see when/what was done and if someone asks why you were charging certain charge lines on a date.
+
* Log of daily activities.  Useful to go back and see when/what was done and if someone asks what you were doing on a date.
−
* Current charge lines using and for what purposes
+
 
* Current git repos/workspaces and what you're doing on each one
 
* Current git repos/workspaces and what you're doing on each one
 
* Things to Do checklist
 
* Things to Do checklist
Line 13: Line 12:
 
<b>NOTE: All items below are examples.</b>   
 
<b>NOTE: All items below are examples.</b>   
 
<pre>
 
<pre>
−
-----------------
+
    -----------------
−
-- Daily Log
+
    -- Daily Log
−
-----------------
+
    -----------------
−
6/11/2020 - Thur
+
    6/11/2020 - Thur
−
  - Pushed new release
+
      - Pushed new release
−
  - Updated Wiki for developers
+
      - Updated Wiki for developers
−
  - Training SSD23553
+
      - Training
−
6/12/2020 - Fri - Vacation
+
    6/12/2020 - Fri - Vacation
−
6/15/2020 - Mon
+
    6/15/2020 - Mon
−
  - Create sample engineering log
+
      - Create sample engineering log
−
  - Meeting w/ Ryan - Release schedule
+
      - Meeting w/ Ryan - Release schedule
  
−
-----------------
+
    ------------------------
−
-- Charge Lines
+
    -- GIT repos/workspaces
−
-----------------
+
    ------------------------
−
- ASDF332K3 - US Army
+
    - Note: <repo> - <branch> - <what doing in each; blank if clean>
−
- EEWAD4332 - Training
+
    - ws_fix/workspace_fix - 0.26.1 - Fixes to Next Release 0.26.1
−
- KSASDF233 - Tool retirement
+
    - ws_try/workspace_try - dev -
 +
    - ws_try/workspace_one - dev - Refactoring ATS to server
  
−
------------------------
+
    ------------------------
−
-- GIT repos/workspaces
+
    -- TTD - In Work
−
------------------------
+
    ------------------------
−
- Note: <repo> - <branch> - <what doing in each; blank if clean>
+
    - Add searching bug to ATS
−
- ws_fix/workspace_fix - 0.26.1 - Fixes to Next Release 0.26.1
+
    - Create sample Engineering Notebook
−
- ws_try/workspace_try - dev -  
+
      DONE - Separate out in sections
−
- ws_try/workspace_one - dev - Refactoring ATS to server
+
      NOW - Add to external wiki
 +
      - Email team members
 +
      - Add to developer's checklist
 +
    - New action > code wf > select workPkg > wp not set in action
 +
    - Add ValidateAtsDatabase to new release
 +
    - Push Beta / Test Jenkins job
  
−
------------------------
+
    ------------------------
−
-- TTD - In Work
+
    -- Misc
−
------------------------
+
    ------------------------
−
- Add searching bug to ATS
+
−
- Create sample Engineering Notebook
+
−
  DONE - Separate out in sections
+
−
  NOW - Add to external wiki
+
−
  - Email team members
+
−
  - Add to developer's checklist
+
−
- New action > code wf > select workPkg > wp not set in action
+
−
- Add ValidateAtsDatabase to new release
+
−
- Push Beta / Test Jenkins job
+
  
−
------------------------
+
    -----------------
−
-- Misc
+
    Outlook / Email
−
------------------------
+
    -----------------
 +
    Setup as Thread - File > Preferences > As Thread
  
−
-----------------
+
    -----------------
−
Outlook / Email
+
    GIT Commands
−
-----------------
+
    -----------------
−
Setup as Thread - File > Preferences > As Thread
+
    git pull --rebase - updates repo
 +
    git rebase -i - interactive rebase
 +
    useful commands: https://www.datree.io/resources/git-commands
  
−
-----------------
+
    -----------------
−
GIT Commands
+
    URLs / Websites
−
-----------------
+
    -----------------
−
git pull --rebase - updates repo
+
    OSEE Wiki - https://wiki.eclipse.org/OSEE
−
git rebase -i - interactive rebase
+
    OSEE Jenkins - https://ci.eclipse.org/osee/
−
useful commands: https://www.datree.io/resources/git-commands
+
    OSEE Gerrit - https://git.eclipse.org/r/#/q/project:osee/org.eclipse.osee
  
−
-----------------
+
    -----------------
−
URLs / Websites
+
    Performance Review Tasks
−
-----------------
+
    -----------------
−
OSEE Wiki - https://wiki.eclipse.org/OSEE
+
    - 2020
−
OSEE Jenkins - https://ci.eclipse.org/osee/
+
      - Mentoring new engineers
−
OSEE Gerrit - https://git.eclipse.org/r/#/q/project:osee/org.eclipse.osee
+
      - Reducing bugs and escapements
 +
      - Retiring legacy peer review tool
  
−
-----------------
+
    -----------------
−
Performance Review Tasks
+
    Accomplishments
−
-----------------
+
    -----------------
−
- 2020
+
    - 2020
−
  - Mentoring new hires
+
      - Mentoring new engineers
−
  - Reducing bugs and escapements
+
      - Cleanup wiki
−
  - Retiring legacy peer review tool
+
      - Retire legacy tools
 +
    - 2019
 +
      - Refactor and code cleanup
 +
      - Training new engineers
  
−
-----------------
+
    -----------------
−
Accomplishments
+
    Daily Log - Archive
−
-----------------
+
    -----------------
−
- 2020
+
    6/10/2020 - Wed
−
  - Mentoring new hires
+
      - Training
−
  - Cleanup wiki
+
    6/9/2020 - Tue
−
  - Retire legacy tools
+
      - Training
−
- 2019
+
−
  - Refactor and code cleanup
+
−
  - Training new hires
+
−
 
+
−
-----------------
+
−
Daily Log - Archive
+
−
-----------------
+
−
6/10/2020 - Wed
+
−
  - Training SSD23553
+
−
6/9/2020 - Tue
+
−
  - Training SSD23553
+
  
  
 
</pre>
 
</pre>

Latest revision as of 19:04, 2 January 2024

Engineering Notebook

This is an example of an Engineering Notebook. Copy this and save to your desktop as a text file and clear out examples to start using.

It serves the following purposes:

  • Log of daily activities. Useful to go back and see when/what was done and if someone asks what you were doing on a date.
  • Current git repos/workspaces and what you're doing on each one
  • Things to Do checklist
  • Notes on different servers/systems/tools/technologies. Organized and searchable.
  • Accomplishments - List of high level accomplishments for year
  • Log archive. Move older daily log to this location.

NOTE: All items below are examples. 

    -----------------
    -- Daily Log
    -----------------
    6/11/2020 - Thur
       - Pushed new release
       - Updated Wiki for developers
       - Training
    6/12/2020 - Fri - Vacation
    6/15/2020 - Mon
       - Create sample engineering log
       - Meeting w/ Ryan - Release schedule

    ------------------------
    -- GIT repos/workspaces
    ------------------------
    - Note: <repo> - <branch> - <what doing in each; blank if clean>
    - ws_fix/workspace_fix - 0.26.1 - Fixes to Next Release 0.26.1
    - ws_try/workspace_try - dev -
    - ws_try/workspace_one - dev - Refactoring ATS to server

    ------------------------
    -- TTD - In Work
    ------------------------
    - Add searching bug to ATS
    - Create sample Engineering Notebook
       DONE - Separate out in sections
       NOW - Add to external wiki
       - Email team members
       - Add to developer's checklist
    - New action > code wf > select workPkg > wp not set in action
    - Add ValidateAtsDatabase to new release
    - Push Beta / Test Jenkins job

    ------------------------
    -- Misc
    ------------------------

    -----------------
    Outlook / Email
    -----------------
    Setup as Thread - File > Preferences > As Thread

    -----------------
    GIT Commands
    -----------------
    git pull --rebase - updates repo
    git rebase -i - interactive rebase
    useful commands: https://www.datree.io/resources/git-commands

    -----------------
    URLs / Websites
    -----------------
    OSEE Wiki - https://wiki.eclipse.org/OSEE
    OSEE Jenkins - https://ci.eclipse.org/osee/
    OSEE Gerrit - https://git.eclipse.org/r/#/q/project:osee/org.eclipse.osee

    -----------------
    Performance Review Tasks
    -----------------
    - 2020
       - Mentoring new engineers
       - Reducing bugs and escapements
       - Retiring legacy peer review tool

    -----------------
    Accomplishments
    -----------------
    - 2020
       - Mentoring new engineers
       - Cleanup wiki
       - Retire legacy tools
    - 2019
       - Refactor and code cleanup
       - Training new engineers

    -----------------
    Daily Log - Archive
    -----------------
    6/10/2020 - Wed
       - Training
    6/9/2020 - Tue
       - Training
Retrieved from "https://wiki.eclipse.org/index.php?title=OSEE/Engineering_Notebook&oldid=449109"

This page was last modified 19:04, 2 January 2024 by Zac Campanella. Based on work by Don Dunne.

Back to the top