search

finos / financial-objects

FINOS Financial Objects Program Documentation
Apache License 2.0
39 stars 15 forks source link

Renaming of finos-fo repo to financial-objects #32

Closed mcleo-d closed 3 years ago

mcleo-d commented 4 years ago

Description

The name of the Financial Objects repository on GitHub finos-fo does not describe the project and is potentially difficult to find in the FINOS organisation and through GitHub and Google Search.

Potential Solution

By renaming the FINOS Financial Objects repository from finos-fo to financial-objects the new repo name describes the project and becomes easier to find in the FINOS GitHub organisation and through search.

The reference to FINOS is also maintained through the FINOS organisation on GitHub which is referred to within the following URL - https://github.com/finos/financial-objects

Potential Risks

  1. The current url https://github.com/finos/finos-fo/ is indexed on Google and is driving traffic to the project.
  2. The current url https://github.com/finos/finos-fo/ is referred to in documentation and will potentially need to change.
  3. The current url https://github.com/finos/finos-fo/ is referred to in code and will potentially need to change.

Next Steps

The viability of the change should be assessed by the Financial Objects project and potentially be discussed on an Open Developer Platform project call before prioritising the change if relevant.

maoo commented 4 years ago

@grizzwolf - any word of wisdom re. the risks around Google indexing? I suppose it's possible to use Google online tools to ask a reindexing of those pages - and remove old references, right?

@mcleo-d - In any case, GitHub will provide a redirect, so we won't loose traffic.

There will also be need to adapt the Docusaurus website build, after renaming the repo; I'd suggest to move the website build to GitHub Actions , see https://finosfoundation.atlassian.net/wiki/spaces/FDX/pages/1411317820/Docusaurus+Build+Action (as it brings some interesting features, such as website preview for pull requests.

mcleo-d commented 4 years ago

It would be good to understand the possible unknowns before possible changes are made. Especially if there are any hard coded references anywhere?

finos-admin commented 3 years ago

Done!

@mcleo-d - we updated our internal metadata; for any reference to the previous URL, we'll rely on the GitHub redirects. Meanwhile, everytime we see a finos-fo, we'll update it to the new URL.

TY!