New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove references to BFF #185

Merged
merged 1 commit into from Oct 26, 2018

Conversation

Projects
None yet
4 participants
@ruxandrafed
Member

ruxandrafed commented Oct 4, 2018

DO NOT MERGE until telus/telus-isomorphic-starter-kit#326 is merged.

Overview

Remove/update references to BFF in all relevant docs.
Forum Issue #227 merge UI / BFF Containers


Meta

Please read and confirm each of the following:

  • this topic was discussed in the Technology Forum (ignore if the pull request represents small changes)
  • provided a descriptive topic and overview of contribution
  • documentation format follows the topic template
  • fork is up to date (Hint: "Syncing a Fork")
  • "work in progress" commits are squashed (Hint: "Squashing Commits")
  • commits follow the Conventional ChangeLog format
  • no sensitive content included, such as:
    • content considered competitive intelligence
    • security & privacy policy violating content
    • keys, tokens or credentials

@ruxandrafed ruxandrafed requested a review from telus/architecture-support as a code owner Oct 4, 2018

@tavogel

This comment has been minimized.

Contributor

tavogel commented Oct 9, 2018

Why are we deleting this? We still have BFFs; we just merged them into a single container.

@ruxandrafed

This comment has been minimized.

Member

ruxandrafed commented Oct 9, 2018

@tavogel Given we don't really use BFFs as they were intended, we've been discussing about slowly removing the term from our discussions and docs and just using the "backend" term. That's the rationale for my changes. But I guess that, yes, I could leave the BFF doc and just update it, but most people know what the purpose of a backend is and what should happen in there, etc.? 🤔

@tavogel

This comment has been minimized.

Contributor

tavogel commented Oct 9, 2018

I don't think it hurts to leave this. The documentation isn't wrong.

@zackiles

This comment has been minimized.

Member

zackiles commented Oct 10, 2018

For the most part, I agree with these changes. Original docs aren't wrong, but Rux's changes better reflect the change in #326 and are easier to reason about for a developer new to Digital.

@tavogel

This comment has been minimized.

Contributor

tavogel commented Oct 10, 2018

Keep in mind the BFF docs were removed from the starter kit as well. So essentially we have a BFF folder with no context. Unexplained acronyms are the worst, especially ones with double meanings.

Maybe if we're rename the starter kit folder to just backend vs bff it makes more sense in the new context. Still feel like we should document when and where to use it though.

@ruxandrafed

This comment has been minimized.

Member

ruxandrafed commented Oct 11, 2018

@tavogel This PR is one of my action items as part of telus/technology-forum#227, which also includes cleaning up the term and renaming bff everywhere, so that we stay consistent ☺ My branch with the merge already has the folders, files, and docs updated accordingly: telus/telus-isomorphic-starter-kit#326.

@tavogel

This comment has been minimized.

Contributor

tavogel commented Oct 11, 2018

Ok I see the /app/bff folder was named as /app/backend now. So I have no problems with this.

@ruxandrafed ruxandrafed added the on hold label Oct 17, 2018

@kspaans kspaans merged commit 257c4bd into telus:master Oct 26, 2018

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment