Skip to content

Commit

Permalink
content commit
Browse files Browse the repository at this point in the history
  • Loading branch information
vinnciane committed Apr 4, 2024
1 parent 09022b7 commit 3e54c87
Show file tree
Hide file tree
Showing 20 changed files with 646 additions and 0 deletions.
73 changes: 73 additions & 0 deletions .github/workflows/pages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
# Sample workflow for building and deploying a Hugo site to GitHub Pages
name: Deploy Hugo site to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

# Default to bash
defaults:
run:
shell: bash

jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.121.1
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
- name: Setup Go
uses: actions/setup-go@v4
with:
go-version: '1.21'
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: ${{ env.HUGO_VERSION }}
extended: true
- name: Build with Hugo
env:
# For maximum backward compatibility with Hugo modules
HUGO_ENVIRONMENT: production
HUGO_ENV: production
run: |
hugo \
--gc --minify \
--baseURL "https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/"
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: ./public

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Hugo output
public/
resources/
.hugo_build.lock

# Editor
.vscode/
15 changes: 15 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This configuration file was automatically generated by Gitpod.
# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
# and commit this file to your remote git repository to share the goodness with others.

# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart

tasks:
- name: Install Hugo
before: brew install hugo
init: echo "Your version of Hugo is `hugo version`" && hugo mod tidy
command: hugo server -D -F --baseURL $(gp url 1313) --liveReloadPort=443 --appendPort=false --bind=0.0.0.0 --disableFastRender

ports:
- port: 1313
onOpen: open-preview
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 me

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
27 changes: 27 additions & 0 deletions assets/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/*
* Style definition lists.
*/
.content :where(dl):not(:where([class~="not-prose"], [class~="not-prose"] *)) {
margin-top: 1.5rem;
}
.content :where(dl):not(:where([class~="not-prose"], [class~="not-prose"] *)) dt {
margin-top: 0.7rem;
margin-bottom: 0.5rem;
font-weight: bolder;
}
.content :where(dl):not(:where([class~="not-prose"], [class~="not-prose"] *)) dd {
margin-top: 0.5rem;
margin-bottom: 0.5rem;
margin-left: 1.5rem;
}

/*
img {
display: inline-block;
}
.content :where(img):not(:where([class~=not-prose],[class~=not-prose] *)) {
margin-top: 0;
margin-bottom: 0;
}
*/
20 changes: 20 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Vinciane Duperthuy
toc: false
---

IMG

Motivated Technical Writer with 12+ years experience in technical communication, including 6+ years for the software industry in an agile environment.
Skilled communicator and team player.
Strong competencies in content architecture, migration and tools implementation.
Proficient in content management, including multilingual content and localization.


## Explore

{{< cards >}}
{{< card link="resume" title="My Resume" icon="user-circle" subtitle="My resume.">}}
{{< card link="samples" title="Writing samples" icon="bookmark" subtitle="writing samples.">}}
{{< /cards >}}

25 changes: 25 additions & 0 deletions content/resume/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Resume
weight: 100
---

Annecy, France


Languages
French – Native
English - Advanced


------------------- ----------------------------
1 MyAddress [email protected]
MyTown 1000 @twitter_handle
MyCountry 1800 my-phone-nr
------------------- ----------------------------


{{< cards >}}
{{< card link="education" title="Education" icon="academic-cap" subtitle="Academic stuff.">}}
{{< card link="experience" title="Experience" icon="briefcase" subtitle="Professionnal experience.">}}
{{< card link="skills" title="Skills" icon="beaker" subtitle="Skills." >}}
{{< /cards >}}
25 changes: 25 additions & 0 deletions content/resume/education.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Education
linktitle: Education
type: docs
weight: 300
---


Professional Degree in Technical writing — Université de Limoges
SEPTEMBER, 2010 - SEPTEMBER, 2011 – Limoges, France
MA in English Studies — Université Savoie Mont Blanc
SEPTEMBER, 2002 - SEPTEMBER, 2005 – Chambéry, France


2010-2014 (expected)
: **PhD, Computer Science**; Awesome University (MyTown)

*Thesis title: Deep Learning Approaches to the Self-Awesomeness
Estimation Problem*

2007-2010
: **BSc, Computer Science and Electrical Engineering**; University of
HomeTown (HomeTown)

*Minor: Awesomeology*
41 changes: 41 additions & 0 deletions content/resume/experience.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Work experience
linktitle: Experience
type: docs
weight: 200
---


LEAD TECHNICAL WRITER — ARCAD Software
FEBRUARY, 2018 - PRESENT – Annecy, France
Software publisher
Led team of writers in creating and maintaining technical documentation for software products.
Collaborated with international technical and consulting teams in an agile environment.
Implemented and maintained documentation tools.

TECHNICAL WRITER — SANDVIK Mining and Construction
MAY, 2017 - JANUARY, 2018 – Lyon, France
Mechanical engineering / Special machines
Developed, translated and managed technical documentation for special machinery (instructions and maintenance manuals, illustrations, datasheets and training).
Produced technical illustrations for spare parts catalogs.

TECHNICAL WRITER, DOCUMENTATION MANAGER — DANIELI Centro Recycling
OCTOBER, 2011 - NOVEMBER, 2016 – Chambéry, France
Mechanical engineering / Special machines
Developed, translated and managed technical documentation for special machinery (instructions and maintenance manuals, illustrations, datasheets and training).
Led risk analysis / conformity of machinery with European directives.

Technical writer (internship)
Jul, 2011 - Aug, 2011
CILASOFT
Metz-Tessy, FR
Software security
Created video tutorials and implemented E-Learning tools and methodology.

Technical writer (internship)
Mar, 2011 - Jun, 2011
AKROS HENSHEL
Chambery, France
Mechanical engineering / Special machines
Transferred legacy documentation into a XML/DITA framework and set up of a modular publishing environment.
General update of technical content.
15 changes: 15 additions & 0 deletions content/resume/skills.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Skills
linktitle: Skills
type: docs
weight: 400
---

Doc-as-code/Markdown
XML/DITA
HTML/CSS
Single Sourcing
Content strategy
Git
Agile methodology
Project management
8 changes: 8 additions & 0 deletions content/samples/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Writing samples
type: docs
weight: 100
---


About these writing samples
63 changes: 63 additions & 0 deletions content/samples/concept.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Writing sample for a concept
linktitle: Concepts
type: docs
weight: 200
---

## Main concepts

### What is DROPS WAP
The DROPS WAP solution is an ARCAD application with a monitoring Web interface.
The DROPS WAP process is fully integrated with the ARCAD deployments: the distribution macro-commands call the DROPS WAP functions. Execute the macro-commands in ARCAD and monitor the results in the DROPS WAP Web Studio.

### How DROPS WAP works

ARCAD application variables are used to control if DROPS WAP is proposed when distributing a release to a target site.​
The standard ARCAD macro-command (DISTRIB) starts and ends the DROPS WAP replication and synchronization process. The progress of the replication and synchronization is monitored with the DROPS WAP Web Studio.​
Files under DROPS WAP pass through two stages: replication and then synchronization.​
Data from production files is replicated into the new file formats in DROPS WAP library.​
New format data is kept in synchronization with production changes via IBM i Journals.​
The synchronization is maintained until DROPS WAP stops.​
DROPS WAP can be stopped and re-started, such as to perform a system backup. It maintains its last known replication or synchronization in its memory.​
DROPS WAP is stopped by a macro-command after ending application activity. The macro-command invokes ARCAD to move the new files and other objects into target libraries.

### DROPS WAP in action

Setup up the solution
Activate the use of DROPS WAP with the ARCAD distribution process on the development site (Setup on the Development site) and the production (target) site (Setup on the Production site).


Configure the DROPS WAP Web Studio to work with your ARCAD server (Source connectors).


Analyze your files
The first general consideration when using DROPS WAP is to make sure you know what files to include in the process. Analyze your application and decide what files to include.


Launch DROPS WAP with ARCAD macro-commands
Run the DISTRIB macro-command to start the distribution of your application release (Distributing with macros).


Edit and validate the list of files to be managed with DROPS WAP (Edit the list of files (LSTWAP)) when the macro-command displays this list.


Ensure the process of DROPS WAP starts (Montoring DWBASE and DWSTRJRNE​ jobs launched to batch).


Monitor progress with the DROPS WAP Web Studio
Monitor the progress of the replication and the synchronization on the DROPS WAP Web Studio (Monitoring file replication).


Wait until all files are copied and synchronized with journals before stopping the live application environment where the new release will be installed. DROPS WAP keeps the file data synchronized until you stop it.


Transfer to production
The Transfer to production is the end of the process, when your data is ready to be deployed along with the rest of the release. When you want to end the production application and to move the new release into production, run the RCVNTWA2 macro-command ending the DROPS WAP process.

## About this sample

This topic aims to provide the user with an overview of the software, its functionality, and a tour of the workflow/user tasks involved. It also includes links to relevant parts of the documentation. I wrote the topic based on notes shared with me by the lead engineer. She then reviewed the topic, and we made adjustments accordingly. After that, my technical writer teammate reviewed the writing quality. I created the first version of this documentation using the Madcap Flare XML toolchain.

## Live documentation
https://help-drops-wap.arcadsoftware.com/Topics/About/MainConcepts.htm
Loading

0 comments on commit 3e54c87

Please sign in to comment.