Skip to content

Commit 81e3528

Browse files
Merge pull request #94 from topcoder-platform/TCA-487_update-topcoder-readme
TCA-487 - update topcoder readme, add syncing with FCC/main instructions
2 parents a14fe44 + 5fd5306 commit 81e3528

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README-TOPCODER.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This file describes the modifications Topcoder made to the freeCodeCamp.org appl
88
- [Learning Platform API](#the-learning-platform-api)
99
- [MongoDB Configuration](#mongodb-configuration)
1010
- [CI/CD Configuration](#cicd-configuration)
11+
- [Syncing with FCC/main](#syncing-with-fccmain)
1112

1213
### The Learning Platform
1314

@@ -52,3 +53,29 @@ In order to connect the [freeCodeCamp API](#learning-platform-api) to the MongoD
5253
We initially attempted to deploy the freeCodeCamp application and API via our standard CircleCI system, however we were never able to get this to work properly. The application build failed repeatedly at various points and was never successful.
5354

5455
Our DevOps team stood-up a new Jenkins CI/CD system in an AWS EC2 instance (see the [Jenkinsfile](./Jenkinsfile) in the project root for details) and this was successful. However, the build and deployment of the application and API currently takes over 20 minutes. We have an outstanding request with the DevOps team to address this.
56+
57+
### Syncing with FCC/main
58+
59+
Here are a few notes regarding how to merge latest from FCC/main
60+
61+
- create a new branch `prod-merge` based off of origin/prod
62+
- fetch latest from FCC
63+
- merge fcc/main into `prod-merge`
64+
- open all conflicts in an editor for a better overview of what has changed
65+
66+
- when there are new elements/features added on FCC, check freecodecamp.org/learn to see the change in action. Keep if it's something usefull. Remove if it's something we specifically got rid of or doesn't match our goals.
67+
- check the bellow list of known changes from our side that need to be kept as they are:
68+
69+
1. Remove "Donate Now" button from everywhere
70+
2. Added QA shortened course (in intro.json)
71+
3. Global font-family changed to Roboto. Font changes should be kept as "ours".
72+
4. Override Mobile Layout.
73+
5. Action Row Icon replacement
74+
6. Added actions to redux
75+
7. Added error message on form fields
76+
8. Changed Font size and color for Editor.css
77+
9.Removed Reset modal, Help modal
78+
9. Added lesson title old course side panel
79+
10. API changes for Auth (I'll write the readme for this item)
80+
81+
- after resolving the conflicts, check the UI is still intact

0 commit comments

Comments
 (0)