The Board of Ethics uses a series of interconnected PDFs to manage documents through SharePoint. This functionality is not available on the WordPress platform, and due to timeline constraints will not be able to be replicated in time for a June 14th 2021 SharePoint shutdown date. This repo facilitates the direct upload of PDFs to specific Ethics Board public folder paths, so that old PDFs will not be lost, and new PDFs can be maintained in the short term.
- Use the GitHub interface to upload a new file to the default (staging) branch.
- After a successful deploy to staging (e.g. https://staging-www.phila.gov/ethicsboard/Advisory%20Opinions/bd.op.2006-001.pdf) create Pull Request into
main. - Merge pull request to publish file(s).
Github is a tool that allows for version management of documents. We will be utilizing this tool for handling documents for BOE at the following link:
https://github.com/CityOfPhiladelphia/phila.gov-boe-aws-deploy/
In order to upload a file, navigate to your repository home page listed above and confirm that you are in the “staging” environment as indicated by the button in the top left of the page.
After confirming the environment, simply drag and drop your file(s) onto the page, which will bring you to a “new commit” page listing the file(s) added. A commit is the breadcrumb that Github uses to track changes made to the repository. From this view, give the commit a descriptive name such as “Adding file X”. Then click the “Commit changes” button.
At this point, the commit is now confirmed in the staging environment, as indicated by the status on the home page.
The file(s) will now be made available at the staging url associated with your repository. Navigate to the “Merge into main” section to copy the file(s) from staging to production.
In order to delete a file, navigate to the file in the folder structure and click on the file link.
From this view, click the trash icon on the right. This will create a new commit to the branch. Click “Commit changes” to confirm deleting the file from the branch.
After the file has been deleted, make sure to follow the instructions at “Merge into main” to apply to production.
Follow the instructions in “Upload file”. Rather than adding a new file, the older version of the file will be replaced with the new version. Make sure to follow the steps in “Merge into main” for the change to be reflected on the production site.
In order to copy your files from staging to production, you will need to create and merge a pull request. To start, click on the “Pull requests” tab from your repository home page.
From this page, click on the “new pull request” button on the top right of the page, which will bring you to the “Compare changes” page.
From here, you will set the “base” branch (the branch that will be modified), and the “compare” branch (the branch with the changes that will apply to the base branch). For this use case, set the base branch to “main” and allow the compare branch to remain “staging”. You should then see any commit messages that have not been merged below.
If the commit list looks accurate, click the “Create pull request” button and click it again in the “Open a pull request” page.
At this point, a “pull request” (a request to modify one branch from another) has been created, but has not applied to the base branch. In order to apply the change, click the “Merge pull request” button.
Lastly, you will need to confirm the merge with the “Confirm merge” button.
After adding, modifying, or deleting a file, you can confirm that your changes have been applied by reviewing in the staging phila.gov environment. For this repository, all files are uploaded at the top directory of https://staging-www.phila.gov/ethicsboard/advisory%20opinions/ or https://staging-www.phila.gov/ethicsboard/settlement%20agreements followed by the name of the file.
After adding, modifying, or deleting a file, you can confirm that your changes have been applied by reviewing in the staging phila.gov environment. For this repository, all files are uploaded at the top directory of https://www.phila.gov/ethicsboard/advisory%20opinions/ or https://www.phila.gov/ethicsboard/settlement%20agreements followed by the name of the file.